API reference · Communities & institutions

Credit union inter-union money

POST/credit-union/{reference}/duesRaise and settle affiliation dues or a levy
POST/credit-union/{reference}/guarantee-claim/{claimReference}/decisionApprove or reject a guarantee claim
POST/credit-union/{reference}/guarantee-claim/{claimReference}/paymentPay an approved guarantee claim
POST/credit-union/{reference}/participationOffer a participation in a loan
POST/credit-union/{reference}/participation/{participationReference}/purchasePurchase an offered participation
GET/credit-union/{reference}/participationsList participations held or sold
POST/credit-union/{reference}/placementPlace surplus with the parent union
POST/credit-union/{reference}/placement/withdrawalWithdraw a placement
GET/credit-union/{reference}/placementsList this union's placements
POST/credit-union/{reference}/portfolio-guaranteeIssue a portfolio guarantee
POST/credit-union/{reference}/portfolio-guarantee/{guaranteeReference}/claimLodge a claim against a portfolio guarantee
GET/credit-union/{reference}/portfolio-guaranteesList portfolio guarantees issued and held
POST/credit-union/{reference}/refinance/{facilityReference}/utilisationReport utilisation against a refinance facility
GET/credit-union/{reference}/report/consolidatedRead the consolidated group report
GET/credit-union/{reference}/report/funding-mixRead the funding mix
GET/credit-union/{reference}/report/group-exposureRead the group exposure

POST Raise and settle affiliation dues or a levy

POST /credit-union/{reference}/dues

One posting produces a journal in each union's books: the payer's expense and the receiver's income. Writing only one side would leave consolidation unable to eliminate.

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: RaiseDuesRequest · Response: GenericResponseListDuesObligationResponse

curl -X POST "https://api.bridgemoni.com/credit-union/b3f1c2d4-5e6a-4b7c-8d9e-0f1a2b3c4d5e/dues" \
  -H "Authorization: Bearer $BRIDGEMONI_TOKEN" \
  -H "X-Tenant: $BRIDGEMONI_TENANT" \
  -H "X-Environment: $BRIDGEMONI_ENV" \
  -H "Content-Type: application/json" \
  -d '{
  "affiliateUnionReference": "b3f1c2d4-5e6a-4b7c-8d9e-0f1a2b3c4d5e",
  "amount": 0,
  "dueOn": "2026-09-25",
  "narrative": "string",
  "levy": true
}'

{
  "affiliateUnionReference": "b3f1c2d4-5e6a-4b7c-8d9e-0f1a2b3c4d5e",
  "amount": 0,
  "dueOn": "2026-09-25",
  "narrative": "string",
  "levy": true
}

{
  "data": [
    {
      "reference": "b3f1c2d4-5e6a-4b7c-8d9e-0f1a2b3c4d5e",
      "parentUnionReference": "b3f1c2d4-5e6a-4b7c-8d9e-0f1a2b3c4d5e",
      "affiliateUnionReference": "b3f1c2d4-5e6a-4b7c-8d9e-0f1a2b3c4d5e",
      "affiliateName": "string",
      "duesModel": "FLAT",
      "amount": 0,
      "currencyCode": "string",
      "dueOn": "2026-09-25",
      "status": "string",
      "levy": true,
      "transactionReference": "b3f1c2d4-5e6a-4b7c-8d9e-0f1a2b3c4d5e"
    }
  ],
  "description": "Dues raised successfully"
}

Responses

Status	When
`200`	Dues raised successfully

POST Approve or reject a guarantee claim

POST /credit-union/{reference}/guarantee-claim/{claimReference}/decision

Headers

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

Path parameters

Name
`reference`
`claimReference`

Query parameters

Name	Default
`approved`	Optional
`reason`	Optional

Example

Response: GenericResponseGuaranteeClaimResponse

curl -X POST "https://api.bridgemoni.com/credit-union/b3f1c2d4-5e6a-4b7c-8d9e-0f1a2b3c4d5e/guarantee-claim/b3f1c2d4-5e6a-4b7c-8d9e-0f1a2b3c4d5e/decision?approved=value" \
  -H "Authorization: Bearer $BRIDGEMONI_TOKEN" \
  -H "X-Tenant: $BRIDGEMONI_TENANT" \
  -H "X-Environment: $BRIDGEMONI_ENV"

{
  "data": {
    "reference": "b3f1c2d4-5e6a-4b7c-8d9e-0f1a2b3c4d5e",
    "guaranteeReference": "b3f1c2d4-5e6a-4b7c-8d9e-0f1a2b3c4d5e",
    "guarantorUnionReference": "b3f1c2d4-5e6a-4b7c-8d9e-0f1a2b3c4d5e",
    "beneficiaryUnionReference": "b3f1c2d4-5e6a-4b7c-8d9e-0f1a2b3c4d5e",
    "loanReference": "b3f1c2d4-5e6a-4b7c-8d9e-0f1a2b3c4d5e",
    "realisedLoss": 0,
    "coveredAmount": 0,
    "status": "LODGED",
    "lodgedOn": "2026-09-25",
    "paidAt": "2026-09-25T10:00:00Z",
    "transactionReference": "b3f1c2d4-5e6a-4b7c-8d9e-0f1a2b3c4d5e",
    "rejectionReason": "string",
    "note": "string"
  },
  "description": "Claim decided successfully"
}

Responses

Status	When
`200`	Claim decided successfully

POST Pay an approved guarantee claim

POST /credit-union/{reference}/guarantee-claim/{claimReference}/payment

Headers

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

Path parameters

Name
`reference`
`claimReference`

Example

Response: GenericResponseGuaranteeClaimResponse

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

{
  "data": {
    "reference": "b3f1c2d4-5e6a-4b7c-8d9e-0f1a2b3c4d5e",
    "guaranteeReference": "b3f1c2d4-5e6a-4b7c-8d9e-0f1a2b3c4d5e",
    "guarantorUnionReference": "b3f1c2d4-5e6a-4b7c-8d9e-0f1a2b3c4d5e",
    "beneficiaryUnionReference": "b3f1c2d4-5e6a-4b7c-8d9e-0f1a2b3c4d5e",
    "loanReference": "b3f1c2d4-5e6a-4b7c-8d9e-0f1a2b3c4d5e",
    "realisedLoss": 0,
    "coveredAmount": 0,
    "status": "LODGED",
    "lodgedOn": "2026-09-25",
    "paidAt": "2026-09-25T10:00:00Z",
    "transactionReference": "b3f1c2d4-5e6a-4b7c-8d9e-0f1a2b3c4d5e",
    "rejectionReason": "string",
    "note": "string"
  },
  "description": "Claim paid successfully"
}

Responses

Status	When
`200`	Claim paid successfully

POST Offer a participation in a loan

POST /credit-union/{reference}/participation

The originator retains at least its minimum for the life of the loan, and the check runs again at every principal repayment.

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: OfferParticipationRequest · Response: GenericResponseParticipationResponse

curl -X POST "https://api.bridgemoni.com/credit-union/b3f1c2d4-5e6a-4b7c-8d9e-0f1a2b3c4d5e/participation" \
  -H "Authorization: Bearer $BRIDGEMONI_TOKEN" \
  -H "X-Tenant: $BRIDGEMONI_TENANT" \
  -H "X-Environment: $BRIDGEMONI_ENV" \
  -H "Content-Type: application/json" \
  -d '{
  "loanReference": "b3f1c2d4-5e6a-4b7c-8d9e-0f1a2b3c4d5e",
  "participantUnionReference": "b3f1c2d4-5e6a-4b7c-8d9e-0f1a2b3c4d5e",
  "sharedBasisPoints": 0,
  "servicingFeeBasisPoints": 0,
  "agreementDocumentReference": "b3f1c2d4-5e6a-4b7c-8d9e-0f1a2b3c4d5e"
}'

{
  "loanReference": "b3f1c2d4-5e6a-4b7c-8d9e-0f1a2b3c4d5e",
  "participantUnionReference": "b3f1c2d4-5e6a-4b7c-8d9e-0f1a2b3c4d5e",
  "sharedBasisPoints": 0,
  "servicingFeeBasisPoints": 0,
  "agreementDocumentReference": "b3f1c2d4-5e6a-4b7c-8d9e-0f1a2b3c4d5e"
}

{
  "data": {
    "reference": "b3f1c2d4-5e6a-4b7c-8d9e-0f1a2b3c4d5e",
    "loanReference": "b3f1c2d4-5e6a-4b7c-8d9e-0f1a2b3c4d5e",
    "originatingUnionReference": "b3f1c2d4-5e6a-4b7c-8d9e-0f1a2b3c4d5e",
    "participantUnionReference": "b3f1c2d4-5e6a-4b7c-8d9e-0f1a2b3c4d5e",
    "sharedBasisPoints": 0,
    "retainedBasisPoints": 0,
    "minimumRetainedBasisPoints": 0,
    "purchaseAmount": 0,
    "servicingFeeBasisPoints": 0,
    "status": "OFFERED",
    "principalReceived": 0,
    "interestReceived": 0,
    "lossShare": 0,
    "currencyCode": "string",
    "purchasedAt": "2026-09-25T10:00:00Z",
    "agreementDocumentReference": "b3f1c2d4-5e6a-4b7c-8d9e-0f1a2b3c4d5e",
    "purchaseTransactionReference": "b3f1c2d4-5e6a-4b7c-8d9e-0f1a2b3c4d5e"
  },
  "description": "Participation offered successfully"
}

Responses

Status	When
`200`	Participation offered successfully

POST Purchase an offered participation

POST /credit-union/{reference}/participation/{participationReference}/purchase

Headers

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

Path parameters

Name
`reference`
`participationReference`

Example

Response: GenericResponseParticipationResponse

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

{
  "data": {
    "reference": "b3f1c2d4-5e6a-4b7c-8d9e-0f1a2b3c4d5e",
    "loanReference": "b3f1c2d4-5e6a-4b7c-8d9e-0f1a2b3c4d5e",
    "originatingUnionReference": "b3f1c2d4-5e6a-4b7c-8d9e-0f1a2b3c4d5e",
    "participantUnionReference": "b3f1c2d4-5e6a-4b7c-8d9e-0f1a2b3c4d5e",
    "sharedBasisPoints": 0,
    "retainedBasisPoints": 0,
    "minimumRetainedBasisPoints": 0,
    "purchaseAmount": 0,
    "servicingFeeBasisPoints": 0,
    "status": "OFFERED",
    "principalReceived": 0,
    "interestReceived": 0,
    "lossShare": 0,
    "currencyCode": "string",
    "purchasedAt": "2026-09-25T10:00:00Z",
    "agreementDocumentReference": "b3f1c2d4-5e6a-4b7c-8d9e-0f1a2b3c4d5e",
    "purchaseTransactionReference": "b3f1c2d4-5e6a-4b7c-8d9e-0f1a2b3c4d5e"
  },
  "description": "Participation purchased successfully"
}

Responses

Status	When
`200`	Participation purchased successfully

GET List participations held or sold

GET /credit-union/{reference}/participations

Headers

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

Path parameters

Name
`reference`

Query parameters

Name	Default
`loanReference`	Optional

Example

Response: GenericResponseListParticipationResponse

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

{
  "data": [
    {
      "reference": "b3f1c2d4-5e6a-4b7c-8d9e-0f1a2b3c4d5e",
      "loanReference": "b3f1c2d4-5e6a-4b7c-8d9e-0f1a2b3c4d5e",
      "originatingUnionReference": "b3f1c2d4-5e6a-4b7c-8d9e-0f1a2b3c4d5e",
      "participantUnionReference": "b3f1c2d4-5e6a-4b7c-8d9e-0f1a2b3c4d5e",
      "sharedBasisPoints": 0,
      "retainedBasisPoints": 0,
      "minimumRetainedBasisPoints": 0,
      "purchaseAmount": 0,
      "servicingFeeBasisPoints": 0,
      "status": "OFFERED",
      "principalReceived": 0,
      "interestReceived": 0,
      "lossShare": 0,
      "currencyCode": "string",
      "purchasedAt": "2026-09-25T10:00:00Z",
      "agreementDocumentReference": "b3f1c2d4-5e6a-4b7c-8d9e-0f1a2b3c4d5e",
      "purchaseTransactionReference": "b3f1c2d4-5e6a-4b7c-8d9e-0f1a2b3c4d5e"
    }
  ],
  "description": "Participations retrieved successfully"
}

Responses

Status	When
`200`	Participations retrieved successfully

POST Place surplus with the parent union

POST /credit-union/{reference}/placement

A placement is a term deposit by a member whose subject is a union, so it uses one statement, one accrual engine and one concentration report. The affiliation's ceiling applies.

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: OpenPlacementRequest · Response: GenericResponsePlacementResponse

curl -X POST "https://api.bridgemoni.com/credit-union/b3f1c2d4-5e6a-4b7c-8d9e-0f1a2b3c4d5e/placement" \
  -H "Authorization: Bearer $BRIDGEMONI_TOKEN" \
  -H "X-Tenant: $BRIDGEMONI_TENANT" \
  -H "X-Environment: $BRIDGEMONI_ENV" \
  -H "Content-Type: application/json" \
  -d '{
  "parentUnionReference": "b3f1c2d4-5e6a-4b7c-8d9e-0f1a2b3c4d5e",
  "depositProductCode": "string",
  "amount": 0,
  "narrative": "string",
  "idempotencyKey": "string"
}'

{
  "parentUnionReference": "b3f1c2d4-5e6a-4b7c-8d9e-0f1a2b3c4d5e",
  "depositProductCode": "string",
  "amount": 0,
  "narrative": "string",
  "idempotencyKey": "string"
}

{
  "data": {
    "reference": "b3f1c2d4-5e6a-4b7c-8d9e-0f1a2b3c4d5e",
    "placingUnionReference": "b3f1c2d4-5e6a-4b7c-8d9e-0f1a2b3c4d5e",
    "parentUnionReference": "b3f1c2d4-5e6a-4b7c-8d9e-0f1a2b3c4d5e",
    "positionReference": "b3f1c2d4-5e6a-4b7c-8d9e-0f1a2b3c4d5e",
    "depositAccountReference": "b3f1c2d4-5e6a-4b7c-8d9e-0f1a2b3c4d5e",
    "depositProductCode": "string",
    "balance": 0,
    "currencyCode": "string",
    "openedOn": "2026-09-25",
    "maturesOn": "2026-09-25",
    "placementCeiling": 0,
    "minimumPlacementAmount": 0,
    "withdrawableWithoutBreachingTheMinimum": 0,
    "transactionReference": "b3f1c2d4-5e6a-4b7c-8d9e-0f1a2b3c4d5e"
  },
  "description": "Placement made successfully"
}

Responses

Status	When
`200`	Placement made successfully

POST Withdraw a placement

POST /credit-union/{reference}/placement/withdrawal

A withdrawal that would breach the statutory minimum is refused with the rule named, and the parent's own liquidity is checked before it pays.

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: WithdrawPlacementRequest · Response: GenericResponsePlacementResponse

curl -X POST "https://api.bridgemoni.com/credit-union/b3f1c2d4-5e6a-4b7c-8d9e-0f1a2b3c4d5e/placement/withdrawal" \
  -H "Authorization: Bearer $BRIDGEMONI_TOKEN" \
  -H "X-Tenant: $BRIDGEMONI_TENANT" \
  -H "X-Environment: $BRIDGEMONI_ENV" \
  -H "Content-Type: application/json" \
  -d '{
  "depositAccountReference": "b3f1c2d4-5e6a-4b7c-8d9e-0f1a2b3c4d5e",
  "amount": 0,
  "narrative": "string",
  "idempotencyKey": "string"
}'

{
  "depositAccountReference": "b3f1c2d4-5e6a-4b7c-8d9e-0f1a2b3c4d5e",
  "amount": 0,
  "narrative": "string",
  "idempotencyKey": "string"
}

{
  "data": {
    "reference": "b3f1c2d4-5e6a-4b7c-8d9e-0f1a2b3c4d5e",
    "placingUnionReference": "b3f1c2d4-5e6a-4b7c-8d9e-0f1a2b3c4d5e",
    "parentUnionReference": "b3f1c2d4-5e6a-4b7c-8d9e-0f1a2b3c4d5e",
    "positionReference": "b3f1c2d4-5e6a-4b7c-8d9e-0f1a2b3c4d5e",
    "depositAccountReference": "b3f1c2d4-5e6a-4b7c-8d9e-0f1a2b3c4d5e",
    "depositProductCode": "string",
    "balance": 0,
    "currencyCode": "string",
    "openedOn": "2026-09-25",
    "maturesOn": "2026-09-25",
    "placementCeiling": 0,
    "minimumPlacementAmount": 0,
    "withdrawableWithoutBreachingTheMinimum": 0,
    "transactionReference": "b3f1c2d4-5e6a-4b7c-8d9e-0f1a2b3c4d5e"
  },
  "description": "Placement withdrawn successfully"
}

Responses

Status	When
`200`	Placement withdrawn successfully

GET List this union's placements

GET /credit-union/{reference}/placements

Headers

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

Path parameters

Name
`reference`

Example

Response: GenericResponseListPlacementResponse

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

{
  "data": [
    {
      "reference": "b3f1c2d4-5e6a-4b7c-8d9e-0f1a2b3c4d5e",
      "placingUnionReference": "b3f1c2d4-5e6a-4b7c-8d9e-0f1a2b3c4d5e",
      "parentUnionReference": "b3f1c2d4-5e6a-4b7c-8d9e-0f1a2b3c4d5e",
      "positionReference": "b3f1c2d4-5e6a-4b7c-8d9e-0f1a2b3c4d5e",
      "depositAccountReference": "b3f1c2d4-5e6a-4b7c-8d9e-0f1a2b3c4d5e",
      "depositProductCode": "string",
      "balance": 0,
      "currencyCode": "string",
      "openedOn": "2026-09-25",
      "maturesOn": "2026-09-25",
      "placementCeiling": 0,
      "minimumPlacementAmount": 0,
      "withdrawableWithoutBreachingTheMinimum": 0,
      "transactionReference": "b3f1c2d4-5e6a-4b7c-8d9e-0f1a2b3c4d5e"
    }
  ],
  "description": "Placements retrieved successfully"
}

Responses

Status	When
`200`	Placements retrieved successfully

POST Issue a portfolio guarantee

POST /credit-union/{reference}/portfolio-guarantee

The only inter-union instrument that moves no money at origination. The guarantor's exposure counts against its limits from the day it is issued.

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: IssueGuaranteeRequest · Response: GenericResponsePortfolioGuaranteeResponse

curl -X POST "https://api.bridgemoni.com/credit-union/b3f1c2d4-5e6a-4b7c-8d9e-0f1a2b3c4d5e/portfolio-guarantee" \
  -H "Authorization: Bearer $BRIDGEMONI_TOKEN" \
  -H "X-Tenant: $BRIDGEMONI_TENANT" \
  -H "X-Environment: $BRIDGEMONI_ENV" \
  -H "Content-Type: application/json" \
  -d '{
  "beneficiaryUnionReference": "b3f1c2d4-5e6a-4b7c-8d9e-0f1a2b3c4d5e",
  "coverageBasisPoints": 0,
  "ceilingAmount": 0,
  "effectiveFrom": "2026-09-25",
  "effectiveTo": "2026-09-25",
  "agreementDocumentReference": "b3f1c2d4-5e6a-4b7c-8d9e-0f1a2b3c4d5e"
}'

{
  "beneficiaryUnionReference": "b3f1c2d4-5e6a-4b7c-8d9e-0f1a2b3c4d5e",
  "coverageBasisPoints": 0,
  "ceilingAmount": 0,
  "effectiveFrom": "2026-09-25",
  "effectiveTo": "2026-09-25",
  "agreementDocumentReference": "b3f1c2d4-5e6a-4b7c-8d9e-0f1a2b3c4d5e"
}

{
  "data": {
    "reference": "b3f1c2d4-5e6a-4b7c-8d9e-0f1a2b3c4d5e",
    "guarantorUnionReference": "b3f1c2d4-5e6a-4b7c-8d9e-0f1a2b3c4d5e",
    "beneficiaryUnionReference": "b3f1c2d4-5e6a-4b7c-8d9e-0f1a2b3c4d5e",
    "coverageBasisPoints": 0,
    "ceilingAmount": 0,
    "claimsPaid": 0,
    "headroom": 0,
    "status": "ACTIVE",
    "effectiveFrom": "2026-09-25",
    "effectiveTo": "2026-09-25",
    "currencyCode": "string",
    "agreementDocumentReference": "b3f1c2d4-5e6a-4b7c-8d9e-0f1a2b3c4d5e"
  },
  "description": "Guarantee issued successfully"
}

Responses

Status	When
`200`	Guarantee issued successfully

POST Lodge a claim against a portfolio guarantee

POST /credit-union/{reference}/portfolio-guarantee/{guaranteeReference}/claim

A guarantee pays on realised loss, never on arrears.

Headers

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

Path parameters

Name
`reference`
`guaranteeReference`

Example

Request body: ClaimGuaranteeRequest · Response: GenericResponseGuaranteeClaimResponse

curl -X POST "https://api.bridgemoni.com/credit-union/b3f1c2d4-5e6a-4b7c-8d9e-0f1a2b3c4d5e/portfolio-guarantee/b3f1c2d4-5e6a-4b7c-8d9e-0f1a2b3c4d5e/claim" \
  -H "Authorization: Bearer $BRIDGEMONI_TOKEN" \
  -H "X-Tenant: $BRIDGEMONI_TENANT" \
  -H "X-Environment: $BRIDGEMONI_ENV" \
  -H "Content-Type: application/json" \
  -d '{
  "loanReference": "b3f1c2d4-5e6a-4b7c-8d9e-0f1a2b3c4d5e",
  "realisedLoss": 0,
  "note": "string"
}'

{
  "loanReference": "b3f1c2d4-5e6a-4b7c-8d9e-0f1a2b3c4d5e",
  "realisedLoss": 0,
  "note": "string"
}

{
  "data": {
    "reference": "b3f1c2d4-5e6a-4b7c-8d9e-0f1a2b3c4d5e",
    "guaranteeReference": "b3f1c2d4-5e6a-4b7c-8d9e-0f1a2b3c4d5e",
    "guarantorUnionReference": "b3f1c2d4-5e6a-4b7c-8d9e-0f1a2b3c4d5e",
    "beneficiaryUnionReference": "b3f1c2d4-5e6a-4b7c-8d9e-0f1a2b3c4d5e",
    "loanReference": "b3f1c2d4-5e6a-4b7c-8d9e-0f1a2b3c4d5e",
    "realisedLoss": 0,
    "coveredAmount": 0,
    "status": "LODGED",
    "lodgedOn": "2026-09-25",
    "paidAt": "2026-09-25T10:00:00Z",
    "transactionReference": "b3f1c2d4-5e6a-4b7c-8d9e-0f1a2b3c4d5e",
    "rejectionReason": "string",
    "note": "string"
  },
  "description": "Claim lodged successfully"
}

Responses

Status	When
`200`	Claim lodged successfully

GET List portfolio guarantees issued and held

GET /credit-union/{reference}/portfolio-guarantees

Headers

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

Path parameters

Name
`reference`

Example

Response: GenericResponseListPortfolioGuaranteeResponse

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

{
  "data": [
    {
      "reference": "b3f1c2d4-5e6a-4b7c-8d9e-0f1a2b3c4d5e",
      "guarantorUnionReference": "b3f1c2d4-5e6a-4b7c-8d9e-0f1a2b3c4d5e",
      "beneficiaryUnionReference": "b3f1c2d4-5e6a-4b7c-8d9e-0f1a2b3c4d5e",
      "coverageBasisPoints": 0,
      "ceilingAmount": 0,
      "claimsPaid": 0,
      "headroom": 0,
      "status": "ACTIVE",
      "effectiveFrom": "2026-09-25",
      "effectiveTo": "2026-09-25",
      "currencyCode": "string",
      "agreementDocumentReference": "b3f1c2d4-5e6a-4b7c-8d9e-0f1a2b3c4d5e"
    }
  ],
  "description": "Guarantees retrieved successfully"
}

Responses

Status	When
`200`	Guarantees retrieved successfully

POST Report utilisation against a refinance facility

POST /credit-union/{reference}/refinance/{facilityReference}/utilisation

Names the member loans disbursed under the facility. The module reports; it does not enforce fungibility, because money is fungible.

Headers

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

Path parameters

Name
`reference`
`facilityReference`

Example

Request body: ReportUtilisationRequest · Response: GenericResponseUtilisationReportResponse

curl -X POST "https://api.bridgemoni.com/credit-union/b3f1c2d4-5e6a-4b7c-8d9e-0f1a2b3c4d5e/refinance/b3f1c2d4-5e6a-4b7c-8d9e-0f1a2b3c4d5e/utilisation" \
  -H "Authorization: Bearer $BRIDGEMONI_TOKEN" \
  -H "X-Tenant: $BRIDGEMONI_TENANT" \
  -H "X-Environment: $BRIDGEMONI_ENV" \
  -H "Content-Type: application/json" \
  -d '{
  "memberLoanReferences": [
    "string"
  ],
  "amountUtilised": 0,
  "reportedFor": "2026-09-25",
  "note": "string"
}'

{
  "memberLoanReferences": [
    "string"
  ],
  "amountUtilised": 0,
  "reportedFor": "2026-09-25",
  "note": "string"
}

{
  "data": {
    "reference": "b3f1c2d4-5e6a-4b7c-8d9e-0f1a2b3c4d5e",
    "facilityLoanReference": "b3f1c2d4-5e6a-4b7c-8d9e-0f1a2b3c4d5e",
    "reportingUnionReference": "b3f1c2d4-5e6a-4b7c-8d9e-0f1a2b3c4d5e",
    "purpose": "AGRICULTURAL_INPUTS",
    "facilityAmount": 0,
    "amountUtilised": 0,
    "cumulativeUtilised": 0,
    "unreportedBalance": 0,
    "memberLoanCount": 0,
    "reportedFor": "2026-09-25",
    "reportedAt": "2026-09-25T10:00:00Z",
    "note": "string"
  },
  "description": "Utilisation reported successfully"
}

Responses

Status	When
`200`	Utilisation reported successfully

GET Read the consolidated group report

GET /credit-union/{reference}/report/consolidated

Walks the subtree and eliminates intra-group balances. Without that a federation's total assets are inflated by every unit its members have placed with it.

Headers

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

Path parameters

Name
`reference`

Query parameters

Name	Default
`asOf`	Optional

Example

Response: GenericResponseConsolidatedReportResponse

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

{
  "data": {
    "unionReference": "b3f1c2d4-5e6a-4b7c-8d9e-0f1a2b3c4d5e",
    "asOf": "2026-09-25",
    "currencyCode": "string",
    "unionsIncluded": 0,
    "unionsWithoutASnapshot": 0,
    "grossTotalAssets": 0,
    "eliminations": {},
    "totalEliminated": 0,
    "consolidatedTotalAssets": 0,
    "consolidatedDeposits": 0,
    "consolidatedLoanPortfolio": 0,
    "consolidatedCoreCapital": 0,
    "caveats": [
      "string"
    ]
  },
  "description": "Consolidated report retrieved successfully"
}

Responses

Status	When
`200`	Consolidated report retrieved successfully

GET Read the funding mix

GET /credit-union/{reference}/report/funding-mix

How much of the portfolio is funded by refinance rather than by member savings — the ratio a supervisor reads first when a society grows faster than its savings.

Headers

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

Path parameters

Name
`reference`

Query parameters

Name	Default
`asOf`	Optional

Example

Response: GenericResponseFundingMixResponse

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

{
  "data": {
    "unionReference": "b3f1c2d4-5e6a-4b7c-8d9e-0f1a2b3c4d5e",
    "asOf": "2026-09-25",
    "currencyCode": "string",
    "loanPortfolio": 0,
    "memberDeposits": 0,
    "shareCapital": 0,
    "borrowedFromParent": 0,
    "refinanceFundedBasisPoints": 0,
    "memberFundedBasisPoints": 0,
    "measurable": true,
    "narrative": "string"
  },
  "description": "Funding mix retrieved successfully"
}

Responses

Status	When
`200`	Funding mix retrieved successfully

GET Read the group exposure

GET /credit-union/{reference}/report/group-exposure

Refinance lent down, participations bought and guarantees issued. Accepted guarantee liability counts from the day it is issued and is usually the largest term.

Headers

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

Path parameters

Name
`reference`

Query parameters

Name	Default
`asOf`	Optional

Example

Response: GenericResponseGroupExposureResponse

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

{
  "data": {
    "unionReference": "b3f1c2d4-5e6a-4b7c-8d9e-0f1a2b3c4d5e",
    "asOf": "2026-09-25",
    "currencyCode": "string",
    "coreCapital": 0,
    "refinanceOutstanding": 0,
    "participationsHeld": 0,
    "guaranteeLiability": 0,
    "totalGroupExposure": 0,
    "exposureBasisPointsOfCapital": 0,
    "limitBasisPoints": 0,
    "withinLimit": true,
    "measurable": true,
    "lines": [
      {
        "counterpartyUnionReference": "b3f1c2d4-5e6a-4b7c-8d9e-0f1a2b3c4d5e",
        "counterpartyName": "string",
        "flow": "AFFILIATION_DUES",
        "amount": 0,
        "basisPointsOfCapital": 0
      }
    ]
  },
  "description": "Group exposure retrieved successfully"
}

Responses

Status	When
`200`	Group exposure retrieved successfully

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