API reference · Communities & institutions

Credit union shares and member settlement

POST/credit-union/{reference}/member/{positionReference}/entrance-feeCharge the entrance fee
POST/credit-union/{reference}/member/{positionReference}/exitSettle a member's exit
GET/credit-union/{reference}/member/{positionReference}/nominationsList a member's nominations
POST/credit-union/{reference}/nomination/depositRecord a nomination
POST/credit-union/{reference}/nomination/deposit/{nominationReference}/revokeRevoke a nomination
GET/credit-union/{reference}/share-registerRead the share register
POST/credit-union/{reference}/shares/purchaseBuy shares
POST/credit-union/{reference}/shares/transferTransfer shares between members

POST Charge the entrance fee

POST /credit-union/{reference}/member/{positionReference}/entrance-fee

A one-off charge on admission, taken from the member's wallet into the union's operating pocket. A class may override the union's figure, and it is charged once.

Headers

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

Path parameters

Name
`reference`
`positionReference`

Example

Request body: ChargeEntranceFeeRequest · Response: GenericResponseDepositMovementResponse

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

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

{
  "data": {
    "reference": "b3f1c2d4-5e6a-4b7c-8d9e-0f1a2b3c4d5e",
    "depositAccountReference": "b3f1c2d4-5e6a-4b7c-8d9e-0f1a2b3c4d5e",
    "positionReference": "b3f1c2d4-5e6a-4b7c-8d9e-0f1a2b3c4d5e",
    "entryType": "ENTRANCE_FEE",
    "direction": "CREDIT",
    "amount": 0,
    "balanceAfter": 0,
    "currencyCode": "string",
    "narrative": "string",
    "transactionReference": "b3f1c2d4-5e6a-4b7c-8d9e-0f1a2b3c4d5e",
    "valueDate": "2026-09-25",
    "postedAt": "2026-09-25T10:00:00Z"
  },
  "description": "Entrance fee received successfully"
}

Responses

Status	When
`200`	Entrance fee received successfully

POST Settle a member's exit

POST /credit-union/{reference}/member/{positionReference}/exit

Charges are settled out of the balance, deposits are refunded and the accounts are closed, then shares are disposed of - by transfer to an incoming member, or by refund only where the bye-laws make shares refundable. Refused while any loan, guarantee or pledged balance is outstanding.

Headers

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

Path parameters

Name
`reference`
`positionReference`

Example

Request body: SettleMemberExitRequest · Response: GenericResponseMemberExitSettlementResponse

curl -X POST "https://api.bridgemoni.com/credit-union/b3f1c2d4-5e6a-4b7c-8d9e-0f1a2b3c4d5e/member/b3f1c2d4-5e6a-4b7c-8d9e-0f1a2b3c4d5e/exit" \
  -H "Authorization: Bearer $BRIDGEMONI_TOKEN" \
  -H "X-Tenant: $BRIDGEMONI_TENANT" \
  -H "X-Environment: $BRIDGEMONI_ENV" \
  -H "Content-Type: application/json" \
  -d '{
  "reason": "RESIGNED",
  "shareDisposalRoute": "TRANSFER",
  "shareTransfereePositionReference": "b3f1c2d4-5e6a-4b7c-8d9e-0f1a2b3c4d5e",
  "idempotencyKey": "string"
}'

{
  "reason": "RESIGNED",
  "shareDisposalRoute": "TRANSFER",
  "shareTransfereePositionReference": "b3f1c2d4-5e6a-4b7c-8d9e-0f1a2b3c4d5e",
  "idempotencyKey": "string"
}

{
  "data": {
    "positionReference": "b3f1c2d4-5e6a-4b7c-8d9e-0f1a2b3c4d5e",
    "currencyCode": "string",
    "depositsRefunded": 0,
    "sharesDisposed": 0,
    "shareDisposalRoute": "TRANSFER",
    "shareTransfereePositionReference": "b3f1c2d4-5e6a-4b7c-8d9e-0f1a2b3c4d5e",
    "closedAccountReferences": [
      "string"
    ],
    "obligationsSettled": 0,
    "netPaidOut": 0
  },
  "description": "Exit settled successfully"
}

Responses

Status	When
`200`	Exit settled successfully

GET List a member's nominations

GET /credit-union/{reference}/member/{positionReference}/nominations

Headers

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

Path parameters

Name
`reference`
`positionReference`

Example

Response: GenericResponseListMemberNominationResponse

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

{
  "data": [
    {
      "reference": "b3f1c2d4-5e6a-4b7c-8d9e-0f1a2b3c4d5e",
      "unionReference": "b3f1c2d4-5e6a-4b7c-8d9e-0f1a2b3c4d5e",
      "positionReference": "b3f1c2d4-5e6a-4b7c-8d9e-0f1a2b3c4d5e",
      "depositAccountReference": "b3f1c2d4-5e6a-4b7c-8d9e-0f1a2b3c4d5e",
      "nomineeName": "string",
      "nomineeUserReference": "b3f1c2d4-5e6a-4b7c-8d9e-0f1a2b3c4d5e",
      "relationship": "string",
      "contactDetail": "string",
      "documentReference": "b3f1c2d4-5e6a-4b7c-8d9e-0f1a2b3c4d5e",
      "status": "RECORDED",
      "recordedOn": "2026-09-25",
      "revokedOn": "2026-09-25",
      "claimedOn": "2026-09-25"
    }
  ],
  "description": "Nominations retrieved successfully"
}

Responses

Status	When
`200`	Nominations retrieved successfully

POST Record a nomination

POST /credit-union/{reference}/nomination/deposit

Who receives a deceased member's deposits, accrued interest and declared dividends. A nominee is not thereby a member, exactly as a signatory is not.

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: RecordNominationRequest · Response: GenericResponseMemberNominationResponse

curl -X POST "https://api.bridgemoni.com/credit-union/b3f1c2d4-5e6a-4b7c-8d9e-0f1a2b3c4d5e/nomination/deposit" \
  -H "Authorization: Bearer $BRIDGEMONI_TOKEN" \
  -H "X-Tenant: $BRIDGEMONI_TENANT" \
  -H "X-Environment: $BRIDGEMONI_ENV" \
  -H "Content-Type: application/json" \
  -d '{
  "positionReference": "b3f1c2d4-5e6a-4b7c-8d9e-0f1a2b3c4d5e",
  "nomineeName": "string",
  "nomineeUserReference": "b3f1c2d4-5e6a-4b7c-8d9e-0f1a2b3c4d5e",
  "relationship": "string",
  "contactDetail": "string",
  "depositAccountReference": "b3f1c2d4-5e6a-4b7c-8d9e-0f1a2b3c4d5e",
  "documentReference": "b3f1c2d4-5e6a-4b7c-8d9e-0f1a2b3c4d5e"
}'

{
  "positionReference": "b3f1c2d4-5e6a-4b7c-8d9e-0f1a2b3c4d5e",
  "nomineeName": "string",
  "nomineeUserReference": "b3f1c2d4-5e6a-4b7c-8d9e-0f1a2b3c4d5e",
  "relationship": "string",
  "contactDetail": "string",
  "depositAccountReference": "b3f1c2d4-5e6a-4b7c-8d9e-0f1a2b3c4d5e",
  "documentReference": "b3f1c2d4-5e6a-4b7c-8d9e-0f1a2b3c4d5e"
}

{
  "data": {
    "reference": "b3f1c2d4-5e6a-4b7c-8d9e-0f1a2b3c4d5e",
    "unionReference": "b3f1c2d4-5e6a-4b7c-8d9e-0f1a2b3c4d5e",
    "positionReference": "b3f1c2d4-5e6a-4b7c-8d9e-0f1a2b3c4d5e",
    "depositAccountReference": "b3f1c2d4-5e6a-4b7c-8d9e-0f1a2b3c4d5e",
    "nomineeName": "string",
    "nomineeUserReference": "b3f1c2d4-5e6a-4b7c-8d9e-0f1a2b3c4d5e",
    "relationship": "string",
    "contactDetail": "string",
    "documentReference": "b3f1c2d4-5e6a-4b7c-8d9e-0f1a2b3c4d5e",
    "status": "RECORDED",
    "recordedOn": "2026-09-25",
    "revokedOn": "2026-09-25",
    "claimedOn": "2026-09-25"
  },
  "description": "Nomination recorded successfully"
}

Responses

Status	When
`200`	Nomination recorded successfully

POST Revoke a nomination

POST /credit-union/{reference}/nomination/deposit/{nominationReference}/revoke

Revoke the standing nomination before recording another, so there is never a moment with two live answers to who is paid.

Headers

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

Path parameters

Name
`reference`
`nominationReference`

Example

Response: GenericResponseMemberNominationResponse

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

{
  "data": {
    "reference": "b3f1c2d4-5e6a-4b7c-8d9e-0f1a2b3c4d5e",
    "unionReference": "b3f1c2d4-5e6a-4b7c-8d9e-0f1a2b3c4d5e",
    "positionReference": "b3f1c2d4-5e6a-4b7c-8d9e-0f1a2b3c4d5e",
    "depositAccountReference": "b3f1c2d4-5e6a-4b7c-8d9e-0f1a2b3c4d5e",
    "nomineeName": "string",
    "nomineeUserReference": "b3f1c2d4-5e6a-4b7c-8d9e-0f1a2b3c4d5e",
    "relationship": "string",
    "contactDetail": "string",
    "documentReference": "b3f1c2d4-5e6a-4b7c-8d9e-0f1a2b3c4d5e",
    "status": "RECORDED",
    "recordedOn": "2026-09-25",
    "revokedOn": "2026-09-25",
    "claimedOn": "2026-09-25"
  },
  "description": "Nomination revoked successfully"
}

Responses

Status	When
`200`	Nomination revoked successfully

GET Read the share register

GET /credit-union/{reference}/share-register

States whether the members' holdings tie to the union's share-capital pocket. A difference is reported as a difference, never rounded away, because a distribution may not be declared on books that do not tie.

Headers

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

Path parameters

Name
`reference`

Query parameters

Name	Default
`page`	0
`size`	25

Example

Response: GenericResponseShareRegisterResponse

curl -X GET "https://api.bridgemoni.com/credit-union/b3f1c2d4-5e6a-4b7c-8d9e-0f1a2b3c4d5e/share-register?page=value&size=25" \
  -H "Authorization: Bearer $BRIDGEMONI_TOKEN" \
  -H "X-Tenant: $BRIDGEMONI_TENANT" \
  -H "X-Environment: $BRIDGEMONI_ENV"

{
  "data": {
    "unionReference": "b3f1c2d4-5e6a-4b7c-8d9e-0f1a2b3c4d5e",
    "currencyCode": "string",
    "issuedShareUnits": 0,
    "issuedShareCapital": 0,
    "pocketBalance": 0,
    "ties": true,
    "holderCount": 0,
    "holdings": [
      {
        "positionReference": "b3f1c2d4-5e6a-4b7c-8d9e-0f1a2b3c4d5e",
        "userReference": "b3f1c2d4-5e6a-4b7c-8d9e-0f1a2b3c4d5e",
        "memberUnionReference": "b3f1c2d4-5e6a-4b7c-8d9e-0f1a2b3c4d5e",
        "memberNumber": "string",
        "membershipClassCode": "LIFE",
        "shareUnits": 0,
        "shareAmount": 0,
        "sharesPledgedAmount": 0,
        "shareUnitDays": 0,
        "currencyCode": "string",
        "holdingBasisPoints": 0,
        "meetsMinimumHolding": true
      }
    ]
  },
  "description": "Share register retrieved successfully"
}

Responses

Status	When
`200`	Share register retrieved successfully

POST Buy shares

POST /credit-union/{reference}/shares/purchase

Shares are ownership, priced in whole units, and they are not a savings balance with a different name: they are not withdrawable, they earn a dividend rather than interest, and they rank behind every other claim in a winding up.

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: PurchaseSharesRequest · Response: GenericResponseDepositAccountResponse

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

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

{
  "data": {
    "reference": "b3f1c2d4-5e6a-4b7c-8d9e-0f1a2b3c4d5e",
    "unionReference": "b3f1c2d4-5e6a-4b7c-8d9e-0f1a2b3c4d5e",
    "positionReference": "b3f1c2d4-5e6a-4b7c-8d9e-0f1a2b3c4d5e",
    "productReference": "b3f1c2d4-5e6a-4b7c-8d9e-0f1a2b3c4d5e",
    "productCode": "string",
    "productVersion": 0,
    "depositType": "SHARE_CAPITAL",
    "accountNumberSuffix": "string",
    "currencyCode": "string",
    "balance": 0,
    "encumberedAmount": 0,
    "accruedInterest": 0,
    "amountDays": 0,
    "openedOn": "2026-09-25",
    "maturesOn": "2026-09-25",
    "noticeGivenOn": "2026-09-25",
    "noticeMaturesOn": "2026-09-25",
    "status": "ACTIVE",
    "lastMovementOn": "2026-09-25",
    "dormantSince": "2026-09-25",
    "closedOn": "2026-09-25",
    "nomineeReference": "b3f1c2d4-5e6a-4b7c-8d9e-0f1a2b3c4d5e",
    "countsTowardLoanMultiplier": true,
    "pledgeable": true,
    "noticePeriodDays": 0,
    "termDays": 0,
    "earlyWithdrawalPenaltyBasisPoints": 0,
    "minimumBalance": 0,
    "frozenTermsHash": "string"
  },
  "description": "Shares purchased successfully"
}

Responses

Status	When
`200`	Shares purchased successfully

POST Transfer shares between members

POST /credit-union/{reference}/shares/transfer

No money moves through the union. The share-capital pocket does not change and two member rows do, which is why recording a transfer as a cash movement would break the books.

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: TransferSharesRequest · Response: GenericResponseShareRegisterResponse

curl -X POST "https://api.bridgemoni.com/credit-union/b3f1c2d4-5e6a-4b7c-8d9e-0f1a2b3c4d5e/shares/transfer" \
  -H "Authorization: Bearer $BRIDGEMONI_TOKEN" \
  -H "X-Tenant: $BRIDGEMONI_TENANT" \
  -H "X-Environment: $BRIDGEMONI_ENV" \
  -H "Content-Type: application/json" \
  -d '{
  "fromPositionReference": "b3f1c2d4-5e6a-4b7c-8d9e-0f1a2b3c4d5e",
  "toPositionReference": "b3f1c2d4-5e6a-4b7c-8d9e-0f1a2b3c4d5e",
  "shareUnits": 0,
  "considerationAmount": 0,
  "reason": "string",
  "idempotencyKey": "string"
}'

{
  "fromPositionReference": "b3f1c2d4-5e6a-4b7c-8d9e-0f1a2b3c4d5e",
  "toPositionReference": "b3f1c2d4-5e6a-4b7c-8d9e-0f1a2b3c4d5e",
  "shareUnits": 0,
  "considerationAmount": 0,
  "reason": "string",
  "idempotencyKey": "string"
}

{
  "data": {
    "unionReference": "b3f1c2d4-5e6a-4b7c-8d9e-0f1a2b3c4d5e",
    "currencyCode": "string",
    "issuedShareUnits": 0,
    "issuedShareCapital": 0,
    "pocketBalance": 0,
    "ties": true,
    "holderCount": 0,
    "holdings": [
      {
        "positionReference": "b3f1c2d4-5e6a-4b7c-8d9e-0f1a2b3c4d5e",
        "userReference": "b3f1c2d4-5e6a-4b7c-8d9e-0f1a2b3c4d5e",
        "memberUnionReference": "b3f1c2d4-5e6a-4b7c-8d9e-0f1a2b3c4d5e",
        "memberNumber": "string",
        "membershipClassCode": "LIFE",
        "shareUnits": 0,
        "shareAmount": 0,
        "sharesPledgedAmount": 0,
        "shareUnitDays": 0,
        "currencyCode": "string",
        "holdingBasisPoints": 0,
        "meetsMinimumHolding": true
      }
    ]
  },
  "description": "Shares transferred successfully"
}

Responses

Status	When
`200`	Shares transferred successfully

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