API reference · Accounts & ledger

Financial Accounts

Multi-currency customer accounts with point-in-time balances, liens and statements. About accounts Live

GET/accountList financial accounts for the current session user
POST/accountCreate a financial account
GET/account/number/{accountNumber}Fetch a financial account by account number
GET/account/organization/{organizationReference}List financial accounts for an organization
GET/account/{reference}Fetch a financial account by reference
PUT/account/{reference}Update a financial account
GET/account/{reference}/approval/levelsList a financial account's approval chain
GET/account/{reference}/balance/aggregateGet the aggregate balance across a financial account's subtree
GET/account/{reference}/balance/streamStream real-time balance changes for a financial account
POST/account/{reference}/blockBlock a financial account
GET/account/{reference}/childrenList the immediate children of a financial account
POST/account/{reference}/closeClose a financial account
GET/account/{reference}/liensList the open liens on a financial account
POST/account/{reference}/limitAdd a limit rule to a financial account
DELETE/account/{reference}/limit/{limitRuleReference}Remove a limit rule override from a financial account
GET/account/{reference}/limitsList the effective limit rules for a financial account
GET/account/{reference}/subtreeList every descendant of a financial account
POST/account/{reference}/unblockUnblock a financial account

GET List financial accounts for the current session user

GET /account

Lists all financial accounts belonging to the user identified by the session context's user reference.

Headers

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

Example

Response: List<FinancialAccountResponse>

curl -X GET "https://api.bridgemoni.com/account" \
  -H "Authorization: Bearer $BRIDGEMONI_TOKEN" \
  -H "X-Tenant: $BRIDGEMONI_TENANT" \
  -H "X-Environment: $BRIDGEMONI_ENV"

{
  "data": [
    {
      "reference": "b3f1c2d4-5e6a-4b7c-8d9e-0f1a2b3c4d5e",
      "name": "Ada Obi",
      "description": "March payroll",
      "type": "main",
      "status": "active",
      "accountNumber": "0123456789",
      "currencyCode": "NGN",
      "availableBalance": 250000.0,
      "reservedBalance": 250000.0,
      "committedBalance": 250000.0,
      "lienedBalance": 250000.0,
      "userReference": "b3f1c2d4-5e6a-4b7c-8d9e-0f1a2b3c4d5e",
      "organizationReference": "b3f1c2d4-5e6a-4b7c-8d9e-0f1a2b3c4d5e",
      "parentAccountReference": "b3f1c2d4-5e6a-4b7c-8d9e-0f1a2b3c4d5e",
      "hierarchyPath": "/root/child",
      "creationDateTime": "2027-03-14T14:30:01",
      "lastUpdatedDateTime": "2027-03-14T14:30:01"
    }
  ],
  "description": "List financial accounts for the current session user"
}

Responses

Status	When
`200`	Financial accounts fetched successfully

POST Create a financial account

POST /account

Opens a new financial account with a zero balance in the active status.

Headers

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

Example

Request body: CreateFinancialAccountRequest · Response: FinancialAccountResponse

curl -X POST "https://api.bridgemoni.com/account" \
  -H "Authorization: Bearer $BRIDGEMONI_TOKEN" \
  -H "X-Tenant: $BRIDGEMONI_TENANT" \
  -H "X-Environment: $BRIDGEMONI_ENV" \
  -H "Content-Type: application/json" \
  -d '{
    "name": "Ada Obi",
    "description": "March payroll",
    "type": "main",
    "accountNumber": "0123456789",
    "currencyCode": "NGN",
    "userReference": "b3f1c2d4-5e6a-4b7c-8d9e-0f1a2b3c4d5e",
    "organizationReference": "b3f1c2d4-5e6a-4b7c-8d9e-0f1a2b3c4d5e",
    "parentAccountReference": "b3f1c2d4-5e6a-4b7c-8d9e-0f1a2b3c4d5e"
  }'

{
  "name": "Ada Obi",
  "description": "March payroll",
  "type": "main",
  "accountNumber": "0123456789",
  "currencyCode": "NGN",
  "userReference": "b3f1c2d4-5e6a-4b7c-8d9e-0f1a2b3c4d5e",
  "organizationReference": "b3f1c2d4-5e6a-4b7c-8d9e-0f1a2b3c4d5e",
  "parentAccountReference": "b3f1c2d4-5e6a-4b7c-8d9e-0f1a2b3c4d5e"
}

{
  "data": {
    "reference": "b3f1c2d4-5e6a-4b7c-8d9e-0f1a2b3c4d5e",
    "name": "Ada Obi",
    "description": "March payroll",
    "type": "main",
    "status": "active",
    "accountNumber": "0123456789",
    "currencyCode": "NGN",
    "availableBalance": 250000.0,
    "reservedBalance": 250000.0,
    "committedBalance": 250000.0,
    "lienedBalance": 250000.0,
    "userReference": "b3f1c2d4-5e6a-4b7c-8d9e-0f1a2b3c4d5e",
    "organizationReference": "b3f1c2d4-5e6a-4b7c-8d9e-0f1a2b3c4d5e",
    "parentAccountReference": "b3f1c2d4-5e6a-4b7c-8d9e-0f1a2b3c4d5e",
    "hierarchyPath": "/root/child",
    "creationDateTime": "2027-03-14T14:30:01",
    "lastUpdatedDateTime": "2027-03-14T14:30:01"
  },
  "description": "Create a financial account"
}

Responses

Status	When
`200`	Financial account created successfully
`409`	An account already exists for the given account number, or for the given user, type, and currency combination

GET Fetch a financial account by account number

GET /account/number/{accountNumber}

Fetches a financial account by its account number.

Headers

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

Path parameters

Name
`accountNumber`

Example

Response: FinancialAccountResponse

curl -X GET "https://api.bridgemoni.com/account/number/0123456789" \
  -H "Authorization: Bearer $BRIDGEMONI_TOKEN" \
  -H "X-Tenant: $BRIDGEMONI_TENANT" \
  -H "X-Environment: $BRIDGEMONI_ENV"

{
  "data": {
    "reference": "b3f1c2d4-5e6a-4b7c-8d9e-0f1a2b3c4d5e",
    "name": "Ada Obi",
    "description": "March payroll",
    "type": "main",
    "status": "active",
    "accountNumber": "0123456789",
    "currencyCode": "NGN",
    "availableBalance": 250000.0,
    "reservedBalance": 250000.0,
    "committedBalance": 250000.0,
    "lienedBalance": 250000.0,
    "userReference": "b3f1c2d4-5e6a-4b7c-8d9e-0f1a2b3c4d5e",
    "organizationReference": "b3f1c2d4-5e6a-4b7c-8d9e-0f1a2b3c4d5e",
    "parentAccountReference": "b3f1c2d4-5e6a-4b7c-8d9e-0f1a2b3c4d5e",
    "hierarchyPath": "/root/child",
    "creationDateTime": "2027-03-14T14:30:01",
    "lastUpdatedDateTime": "2027-03-14T14:30:01"
  },
  "description": "Fetch a financial account by account number"
}

Responses

Status	When
`200`	Financial account fetched successfully
`404`	No financial account exists for the given account number

GET List financial accounts for an organization

GET /account/organization/{organizationReference}

Lists all financial accounts tagged with the given organization reference.

Headers

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

Path parameters

Name
`organizationReference`

Example

Response: List<FinancialAccountResponse>

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

{
  "data": [
    {
      "reference": "b3f1c2d4-5e6a-4b7c-8d9e-0f1a2b3c4d5e",
      "name": "Ada Obi",
      "description": "March payroll",
      "type": "main",
      "status": "active",
      "accountNumber": "0123456789",
      "currencyCode": "NGN",
      "availableBalance": 250000.0,
      "reservedBalance": 250000.0,
      "committedBalance": 250000.0,
      "lienedBalance": 250000.0,
      "userReference": "b3f1c2d4-5e6a-4b7c-8d9e-0f1a2b3c4d5e",
      "organizationReference": "b3f1c2d4-5e6a-4b7c-8d9e-0f1a2b3c4d5e",
      "parentAccountReference": "b3f1c2d4-5e6a-4b7c-8d9e-0f1a2b3c4d5e",
      "hierarchyPath": "/root/child",
      "creationDateTime": "2027-03-14T14:30:01",
      "lastUpdatedDateTime": "2027-03-14T14:30:01"
    }
  ],
  "description": "List financial accounts for an organization"
}

Responses

Status	When
`200`	Organization financial accounts fetched successfully

GET Fetch a financial account by reference

GET /account/{reference}

Fetches a financial account by its reference. Use this for grouping/container accounts (wallets, organizations), which have no account number.

Headers

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

Path parameters

Name
`reference`

Example

Response: FinancialAccountResponse

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

{
  "data": {
    "reference": "b3f1c2d4-5e6a-4b7c-8d9e-0f1a2b3c4d5e",
    "name": "Ada Obi",
    "description": "March payroll",
    "type": "main",
    "status": "active",
    "accountNumber": "0123456789",
    "currencyCode": "NGN",
    "availableBalance": 250000.0,
    "reservedBalance": 250000.0,
    "committedBalance": 250000.0,
    "lienedBalance": 250000.0,
    "userReference": "b3f1c2d4-5e6a-4b7c-8d9e-0f1a2b3c4d5e",
    "organizationReference": "b3f1c2d4-5e6a-4b7c-8d9e-0f1a2b3c4d5e",
    "parentAccountReference": "b3f1c2d4-5e6a-4b7c-8d9e-0f1a2b3c4d5e",
    "hierarchyPath": "/root/child",
    "creationDateTime": "2027-03-14T14:30:01",
    "lastUpdatedDateTime": "2027-03-14T14:30:01"
  },
  "description": "Fetch a financial account by reference"
}

Responses

Status	When
`200`	Financial account fetched successfully
`404`	No financial account exists for the given reference

PUT Update a financial account

PUT /account/{reference}

Partially updates a financial account. Only non-null fields in the request body are applied.

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: UpdateFinancialAccountRequest · Response: FinancialAccountResponse

curl -X PUT "https://api.bridgemoni.com/account/b3f1c2d4-5e6a-4b7c-8d9e-0f1a2b3c4d5e" \
  -H "Authorization: Bearer $BRIDGEMONI_TOKEN" \
  -H "X-Tenant: $BRIDGEMONI_TENANT" \
  -H "X-Environment: $BRIDGEMONI_ENV" \
  -H "Content-Type: application/json" \
  -d '{
    "name": "Ada Obi",
    "description": "March payroll"
  }'

{
  "name": "Ada Obi",
  "description": "March payroll"
}

{
  "data": {
    "reference": "b3f1c2d4-5e6a-4b7c-8d9e-0f1a2b3c4d5e",
    "name": "Ada Obi",
    "description": "March payroll",
    "type": "main",
    "status": "active",
    "accountNumber": "0123456789",
    "currencyCode": "NGN",
    "availableBalance": 250000.0,
    "reservedBalance": 250000.0,
    "committedBalance": 250000.0,
    "lienedBalance": 250000.0,
    "userReference": "b3f1c2d4-5e6a-4b7c-8d9e-0f1a2b3c4d5e",
    "organizationReference": "b3f1c2d4-5e6a-4b7c-8d9e-0f1a2b3c4d5e",
    "parentAccountReference": "b3f1c2d4-5e6a-4b7c-8d9e-0f1a2b3c4d5e",
    "hierarchyPath": "/root/child",
    "creationDateTime": "2027-03-14T14:30:01",
    "lastUpdatedDateTime": "2027-03-14T14:30:01"
  },
  "description": "Update a financial account"
}

Responses

Status	When
`200`	Financial account updated successfully
`404`	No financial account exists for the given reference

GET List a financial account's approval chain

GET /account/{reference}/approval/levels

Lists every active approval level for the account, ordered by level number.

Headers

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

Path parameters

Name
`reference`

Example

Response: List<AccountApprovalLevelResponse>

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

{
  "data": [
    {
      "reference": "b3f1c2d4-5e6a-4b7c-8d9e-0f1a2b3c4d5e",
      "accountReference": "b3f1c2d4-5e6a-4b7c-8d9e-0f1a2b3c4d5e",
      "levelNumber": 1,
      "approverUserReference": "b3f1c2d4-5e6a-4b7c-8d9e-0f1a2b3c4d5e",
      "description": "March payroll",
      "active": true,
      "creationDateTime": "2027-03-14T14:30:01"
    }
  ],
  "description": "List a financial account's approval chain"
}

Responses

Status	When
`200`	Approval levels fetched successfully

GET Get the aggregate balance across a financial account's subtree

GET /account/{reference}/balance/aggregate

Sums the available/reserved/committed balances of every leaf (transactable) account beneath the given account, grouped by currency. Computed on demand - not a stored or cached rollup.

Headers

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

Path parameters

Name
`reference`

Example

Response: AggregateBalanceResponse

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

{
  "data": {
    "rootReference": "b3f1c2d4-5e6a-4b7c-8d9e-0f1a2b3c4d5e",
    "accountCount": 1,
    "balances": [
      {
        "currencyCode": "NGN",
        "availableBalance": 250000.0,
        "reservedBalance": 250000.0,
        "committedBalance": 250000.0,
        "accountCount": 1
      }
    ]
  },
  "description": "Get the aggregate balance across a financial account's subtree"
}

Responses

Status	When
`200`	Aggregate balance computed successfully

GET Stream real-time balance changes for a financial account

GET /account/{reference}/balance/stream

Opens a Server-Sent Events stream that pushes a balance update every time this account's available/reserved/committed balances change.

Headers

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

Path parameters

Name
`reference`

Example

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

{
  "description": "Stream real-time balance changes for a financial account"
}

Responses

Status	When
`200`	Stream opened successfully
`404`	No financial account exists for the given reference

POST Block a financial account

POST /account/{reference}/block

Sets the account's status to blocked, preventing further activity.

Headers

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

Path parameters

Name
`reference`

Example

Response: FinancialAccountResponse

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

{
  "data": {
    "reference": "b3f1c2d4-5e6a-4b7c-8d9e-0f1a2b3c4d5e",
    "name": "Ada Obi",
    "description": "March payroll",
    "type": "main",
    "status": "active",
    "accountNumber": "0123456789",
    "currencyCode": "NGN",
    "availableBalance": 250000.0,
    "reservedBalance": 250000.0,
    "committedBalance": 250000.0,
    "lienedBalance": 250000.0,
    "userReference": "b3f1c2d4-5e6a-4b7c-8d9e-0f1a2b3c4d5e",
    "organizationReference": "b3f1c2d4-5e6a-4b7c-8d9e-0f1a2b3c4d5e",
    "parentAccountReference": "b3f1c2d4-5e6a-4b7c-8d9e-0f1a2b3c4d5e",
    "hierarchyPath": "/root/child",
    "creationDateTime": "2027-03-14T14:30:01",
    "lastUpdatedDateTime": "2027-03-14T14:30:01"
  },
  "description": "Block a financial account"
}

Responses

Status	When
`200`	Financial account blocked successfully
`404`	No financial account exists for the given reference

GET List the immediate children of a financial account

GET /account/{reference}/children

Lists all financial accounts whose parent is the given account reference.

Headers

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

Path parameters

Name
`reference`

Example

Response: List<FinancialAccountResponse>

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

{
  "data": [
    {
      "reference": "b3f1c2d4-5e6a-4b7c-8d9e-0f1a2b3c4d5e",
      "name": "Ada Obi",
      "description": "March payroll",
      "type": "main",
      "status": "active",
      "accountNumber": "0123456789",
      "currencyCode": "NGN",
      "availableBalance": 250000.0,
      "reservedBalance": 250000.0,
      "committedBalance": 250000.0,
      "lienedBalance": 250000.0,
      "userReference": "b3f1c2d4-5e6a-4b7c-8d9e-0f1a2b3c4d5e",
      "organizationReference": "b3f1c2d4-5e6a-4b7c-8d9e-0f1a2b3c4d5e",
      "parentAccountReference": "b3f1c2d4-5e6a-4b7c-8d9e-0f1a2b3c4d5e",
      "hierarchyPath": "/root/child",
      "creationDateTime": "2027-03-14T14:30:01",
      "lastUpdatedDateTime": "2027-03-14T14:30:01"
    }
  ],
  "description": "List the immediate children of a financial account"
}

Responses

Status	When
`200`	Child financial accounts fetched successfully

POST Close a financial account

POST /account/{reference}/close

Sets the account's status to closed.

Headers

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

Path parameters

Name
`reference`

Example

Response: FinancialAccountResponse

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

{
  "data": {
    "reference": "b3f1c2d4-5e6a-4b7c-8d9e-0f1a2b3c4d5e",
    "name": "Ada Obi",
    "description": "March payroll",
    "type": "main",
    "status": "active",
    "accountNumber": "0123456789",
    "currencyCode": "NGN",
    "availableBalance": 250000.0,
    "reservedBalance": 250000.0,
    "committedBalance": 250000.0,
    "lienedBalance": 250000.0,
    "userReference": "b3f1c2d4-5e6a-4b7c-8d9e-0f1a2b3c4d5e",
    "organizationReference": "b3f1c2d4-5e6a-4b7c-8d9e-0f1a2b3c4d5e",
    "parentAccountReference": "b3f1c2d4-5e6a-4b7c-8d9e-0f1a2b3c4d5e",
    "hierarchyPath": "/root/child",
    "creationDateTime": "2027-03-14T14:30:01",
    "lastUpdatedDateTime": "2027-03-14T14:30:01"
  },
  "description": "Close a financial account"
}

Responses

Status	When
`200`	Financial account closed successfully
`404`	No financial account exists for the given reference

GET List the open liens on a financial account

GET /account/{reference}/liens

Lists every lien currently placed on the account - amounts moved out of available balance into the liened tier that have not yet been released.

Headers

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

Path parameters

Name
`reference`

Example

Response: List<LienResponse>

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

{
  "data": [
    {
      "transactionReference": "financial transaction reference",
      "accountReference": "b3f1c2d4-5e6a-4b7c-8d9e-0f1a2b3c4d5e",
      "amount": 250000.0,
      "narrative": "March payroll",
      "postingDateTime": "2027-03-14T14:30:01"
    }
  ],
  "description": "List the open liens on a financial account"
}

Responses

Status	When
`200`	Liens fetched successfully

POST Add a limit rule to a financial account

POST /account/{reference}/limit

Configures a per-transaction, cumulative, velocity, or minimum-balance limit for the account, overriding the account-type default for that limit type.

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: CreateAccountLimitRuleRequest · Response: AccountLimitRuleResponse

curl -X POST "https://api.bridgemoni.com/account/b3f1c2d4-5e6a-4b7c-8d9e-0f1a2b3c4d5e/limit" \
  -H "Authorization: Bearer $BRIDGEMONI_TOKEN" \
  -H "X-Tenant: $BRIDGEMONI_TENANT" \
  -H "X-Environment: $BRIDGEMONI_ENV" \
  -H "Content-Type: application/json" \
  -d '{
    "limitType": "AMOUNT",
    "period": "SINGLE",
    "enforcementMode": "BLOCKING",
    "thresholdValue": 250000.0
  }'

{
  "limitType": "AMOUNT",
  "period": "SINGLE",
  "enforcementMode": "BLOCKING",
  "thresholdValue": 250000.0
}

{
  "data": {
    "reference": "b3f1c2d4-5e6a-4b7c-8d9e-0f1a2b3c4d5e",
    "accountReference": "b3f1c2d4-5e6a-4b7c-8d9e-0f1a2b3c4d5e",
    "limitType": "AMOUNT",
    "period": "SINGLE",
    "enforcementMode": "BLOCKING",
    "thresholdValue": 250000.0,
    "defaultRule": true,
    "creationDateTime": "2027-03-14T14:30:01"
  },
  "description": "Add a limit rule to a financial account"
}

Responses

Status	When
`200`	Limit rule created successfully
`404`	No financial account exists for the given reference

DELETE Remove a limit rule override from a financial account

DELETE /account/{reference}/limit/{limitRuleReference}

Deletes the explicit override, reverting that limit type to the account-type default (or to no limit, if the type has no default).

Headers

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

Path parameters

Name
`reference`
`limitRuleReference`

Example

Response: Void

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

{
  "description": "Remove a limit rule override from a financial account"
}

Responses

Status	When
`200`	Limit rule deleted successfully
`404`	No limit rule exists for the given reference on this account

GET List the effective limit rules for a financial account

GET /account/{reference}/limits

Lists every limit rule that applies to this account - explicit overrides plus the account-type defaults for any limit type without an override, tagged so callers can tell which is which.

Headers

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

Path parameters

Name
`reference`

Example

Response: List<AccountLimitRuleResponse>

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

{
  "data": [
    {
      "reference": "b3f1c2d4-5e6a-4b7c-8d9e-0f1a2b3c4d5e",
      "accountReference": "b3f1c2d4-5e6a-4b7c-8d9e-0f1a2b3c4d5e",
      "limitType": "AMOUNT",
      "period": "SINGLE",
      "enforcementMode": "BLOCKING",
      "thresholdValue": 250000.0,
      "defaultRule": true,
      "creationDateTime": "2027-03-14T14:30:01"
    }
  ],
  "description": "List the effective limit rules for a financial account"
}

Responses

Status	When
`200`	Limit rules fetched successfully

GET List every descendant of a financial account

GET /account/{reference}/subtree

Lists the given account and every account beneath it in the hierarchy, at any depth.

Headers

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

Path parameters

Name
`reference`

Example

Response: List<FinancialAccountResponse>

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

{
  "data": [
    {
      "reference": "b3f1c2d4-5e6a-4b7c-8d9e-0f1a2b3c4d5e",
      "name": "Ada Obi",
      "description": "March payroll",
      "type": "main",
      "status": "active",
      "accountNumber": "0123456789",
      "currencyCode": "NGN",
      "availableBalance": 250000.0,
      "reservedBalance": 250000.0,
      "committedBalance": 250000.0,
      "lienedBalance": 250000.0,
      "userReference": "b3f1c2d4-5e6a-4b7c-8d9e-0f1a2b3c4d5e",
      "organizationReference": "b3f1c2d4-5e6a-4b7c-8d9e-0f1a2b3c4d5e",
      "parentAccountReference": "b3f1c2d4-5e6a-4b7c-8d9e-0f1a2b3c4d5e",
      "hierarchyPath": "/root/child",
      "creationDateTime": "2027-03-14T14:30:01",
      "lastUpdatedDateTime": "2027-03-14T14:30:01"
    }
  ],
  "description": "List every descendant of a financial account"
}

Responses

Status	When
`200`	Subtree fetched successfully

POST Unblock a financial account

POST /account/{reference}/unblock

Sets a previously blocked account's status back to active.

Headers

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

Path parameters

Name
`reference`

Example

Response: FinancialAccountResponse

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

{
  "data": {
    "reference": "b3f1c2d4-5e6a-4b7c-8d9e-0f1a2b3c4d5e",
    "name": "Ada Obi",
    "description": "March payroll",
    "type": "main",
    "status": "active",
    "accountNumber": "0123456789",
    "currencyCode": "NGN",
    "availableBalance": 250000.0,
    "reservedBalance": 250000.0,
    "committedBalance": 250000.0,
    "lienedBalance": 250000.0,
    "userReference": "b3f1c2d4-5e6a-4b7c-8d9e-0f1a2b3c4d5e",
    "organizationReference": "b3f1c2d4-5e6a-4b7c-8d9e-0f1a2b3c4d5e",
    "parentAccountReference": "b3f1c2d4-5e6a-4b7c-8d9e-0f1a2b3c4d5e",
    "hierarchyPath": "/root/child",
    "creationDateTime": "2027-03-14T14:30:01",
    "lastUpdatedDateTime": "2027-03-14T14:30:01"
  },
  "description": "Unblock a financial account"
}

Responses

Status	When
`200`	Financial account unblocked successfully
`404`	No financial account exists for the given reference

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