API reference · Communities & institutions

Credit union guarantees

POST/credit-union/{reference}/guarantee/{guaranteeReference}/acceptAccept a guarantee
POST/credit-union/{reference}/guarantee/{guaranteeReference}/declineDecline a guarantee
POST/credit-union/{reference}/guarantee/{guaranteeReference}/releaseRelease a guarantee
POST/credit-union/{reference}/guarantee/{guaranteeReference}/substituteSubstitute a guarantor
GET/credit-union/{reference}/member/{positionReference}/guarantee-liabilityWhat this member stands behind
GET/credit-union/{reference}/member/{positionReference}/guarantee-requestsWhat this member has been asked to guarantee

POST Accept a guarantee

POST /credit-union/{reference}/guarantee/{guaranteeReference}/accept

The acceptance is what encumbers the guarantor's deposits, taken under a lock on their position so two acceptances cannot consume the same free balance. Only a pledgeable balance counts, and an office holder may not guarantee a loan in their own institution.

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: AcceptGuaranteeRequest · Response: GenericResponseLoanGuaranteeResponse

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

{
  "amount": 0
}

{
  "data": {
    "reference": "b3f1c2d4-5e6a-4b7c-8d9e-0f1a2b3c4d5e",
    "loanReference": "b3f1c2d4-5e6a-4b7c-8d9e-0f1a2b3c4d5e",
    "guarantorPositionReference": "b3f1c2d4-5e6a-4b7c-8d9e-0f1a2b3c4d5e",
    "guarantorMemberNumber": "string",
    "amountGuaranteed": 0,
    "currencyCode": "string",
    "status": "REQUESTED",
    "requestedAt": "2026-09-25T10:00:00Z",
    "respondedAt": "2026-09-25T10:00:00Z",
    "releasedAt": "2026-09-25T10:00:00Z",
    "calledAt": "2026-09-25T10:00:00Z",
    "amountRecovered": 0,
    "substitutedByGuaranteeReference": "b3f1c2d4-5e6a-4b7c-8d9e-0f1a2b3c4d5e",
    "selfGuarantee": true,
    "declineReason": "string"
  },
  "description": "Guarantee accepted successfully"
}

Responses

Status	When
`200`	Guarantee accepted successfully

POST Decline a guarantee

POST /credit-union/{reference}/guarantee/{guaranteeReference}/decline

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: DeclineGuaranteeRequest · Response: GenericResponseLoanGuaranteeResponse

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

{
  "reason": "string"
}

{
  "data": {
    "reference": "b3f1c2d4-5e6a-4b7c-8d9e-0f1a2b3c4d5e",
    "loanReference": "b3f1c2d4-5e6a-4b7c-8d9e-0f1a2b3c4d5e",
    "guarantorPositionReference": "b3f1c2d4-5e6a-4b7c-8d9e-0f1a2b3c4d5e",
    "guarantorMemberNumber": "string",
    "amountGuaranteed": 0,
    "currencyCode": "string",
    "status": "REQUESTED",
    "requestedAt": "2026-09-25T10:00:00Z",
    "respondedAt": "2026-09-25T10:00:00Z",
    "releasedAt": "2026-09-25T10:00:00Z",
    "calledAt": "2026-09-25T10:00:00Z",
    "amountRecovered": 0,
    "substitutedByGuaranteeReference": "b3f1c2d4-5e6a-4b7c-8d9e-0f1a2b3c4d5e",
    "selfGuarantee": true,
    "declineReason": "string"
  },
  "description": "Guarantee declined successfully"
}

Responses

Status	When
`200`	Guarantee declined successfully

POST Release a guarantee

POST /credit-union/{reference}/guarantee/{guaranteeReference}/release

An officer act, and it needs a reason: releasing security is a decision.

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: ReleaseGuaranteeRequest · Response: GenericResponseLoanGuaranteeResponse

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

{
  "reason": "string"
}

{
  "data": {
    "reference": "b3f1c2d4-5e6a-4b7c-8d9e-0f1a2b3c4d5e",
    "loanReference": "b3f1c2d4-5e6a-4b7c-8d9e-0f1a2b3c4d5e",
    "guarantorPositionReference": "b3f1c2d4-5e6a-4b7c-8d9e-0f1a2b3c4d5e",
    "guarantorMemberNumber": "string",
    "amountGuaranteed": 0,
    "currencyCode": "string",
    "status": "REQUESTED",
    "requestedAt": "2026-09-25T10:00:00Z",
    "respondedAt": "2026-09-25T10:00:00Z",
    "releasedAt": "2026-09-25T10:00:00Z",
    "calledAt": "2026-09-25T10:00:00Z",
    "amountRecovered": 0,
    "substitutedByGuaranteeReference": "b3f1c2d4-5e6a-4b7c-8d9e-0f1a2b3c4d5e",
    "selfGuarantee": true,
    "declineReason": "string"
  },
  "description": "Guarantee released successfully"
}

Responses

Status	When
`200`	Guarantee released successfully

POST Substitute a guarantor

POST /credit-union/{reference}/guarantee/{guaranteeReference}/substitute

The replacement is accepted and its encumbrance taken before the original is released, never the other way round, so the loan is never uncovered between the two writes.

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: SubstituteGuaranteeRequest · Response: GenericResponseLoanGuaranteeResponse

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

{
  "replacementPositionReference": "b3f1c2d4-5e6a-4b7c-8d9e-0f1a2b3c4d5e",
  "amount": 0,
  "reason": "string"
}

{
  "data": {
    "reference": "b3f1c2d4-5e6a-4b7c-8d9e-0f1a2b3c4d5e",
    "loanReference": "b3f1c2d4-5e6a-4b7c-8d9e-0f1a2b3c4d5e",
    "guarantorPositionReference": "b3f1c2d4-5e6a-4b7c-8d9e-0f1a2b3c4d5e",
    "guarantorMemberNumber": "string",
    "amountGuaranteed": 0,
    "currencyCode": "string",
    "status": "REQUESTED",
    "requestedAt": "2026-09-25T10:00:00Z",
    "respondedAt": "2026-09-25T10:00:00Z",
    "releasedAt": "2026-09-25T10:00:00Z",
    "calledAt": "2026-09-25T10:00:00Z",
    "amountRecovered": 0,
    "substitutedByGuaranteeReference": "b3f1c2d4-5e6a-4b7c-8d9e-0f1a2b3c4d5e",
    "selfGuarantee": true,
    "declineReason": "string"
  },
  "description": "Guarantee substituted successfully"
}

Responses

Status	When
`200`	Guarantee substituted successfully

GET What this member stands behind

GET /credit-union/{reference}/member/{positionReference}/guarantee-liability

Their own borrowing plus their accepted guarantee liability. The second term is usually the larger one, and a limit that looks only at a member's own loan sees a fraction of their exposure to the society.

Headers

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

Path parameters

Name
`reference`
`positionReference`

Example

Response: GenericResponseGuaranteeLiabilityResponse

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

{
  "data": {
    "positionReference": "b3f1c2d4-5e6a-4b7c-8d9e-0f1a2b3c4d5e",
    "memberNumber": "string",
    "currencyCode": "string",
    "guaranteeLiability": 0,
    "ownOutstandingPrincipal": 0,
    "totalExposure": 0,
    "pledgeableRemaining": 0,
    "liveGuaranteeCount": 0,
    "guarantees": [
      {
        "reference": "b3f1c2d4-5e6a-4b7c-8d9e-0f1a2b3c4d5e",
        "loanReference": "b3f1c2d4-5e6a-4b7c-8d9e-0f1a2b3c4d5e",
        "guarantorPositionReference": "b3f1c2d4-5e6a-4b7c-8d9e-0f1a2b3c4d5e",
        "guarantorMemberNumber": "string",
        "amountGuaranteed": 0,
        "currencyCode": "string",
        "status": "REQUESTED",
        "requestedAt": "2026-09-25T10:00:00Z",
        "respondedAt": "2026-09-25T10:00:00Z",
        "releasedAt": "2026-09-25T10:00:00Z",
        "calledAt": "2026-09-25T10:00:00Z",
        "amountRecovered": 0,
        "substitutedByGuaranteeReference": "b3f1c2d4-5e6a-4b7c-8d9e-0f1a2b3c4d5e",
        "selfGuarantee": true,
        "declineReason": "string"
      }
    ]
  },
  "description": "Guarantee liability retrieved successfully"
}

Responses

Status	When
`200`	Guarantee liability retrieved successfully

GET What this member has been asked to guarantee

GET /credit-union/{reference}/member/{positionReference}/guarantee-requests

Requests only. Nothing here has encumbered anything yet.

Headers

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

Path parameters

Name
`reference`
`positionReference`

Example

Response: GenericResponseListLoanGuaranteeResponse

curl -X GET "https://api.bridgemoni.com/credit-union/b3f1c2d4-5e6a-4b7c-8d9e-0f1a2b3c4d5e/member/b3f1c2d4-5e6a-4b7c-8d9e-0f1a2b3c4d5e/guarantee-requests" \
  -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",
      "guarantorPositionReference": "b3f1c2d4-5e6a-4b7c-8d9e-0f1a2b3c4d5e",
      "guarantorMemberNumber": "string",
      "amountGuaranteed": 0,
      "currencyCode": "string",
      "status": "REQUESTED",
      "requestedAt": "2026-09-25T10:00:00Z",
      "respondedAt": "2026-09-25T10:00:00Z",
      "releasedAt": "2026-09-25T10:00:00Z",
      "calledAt": "2026-09-25T10:00:00Z",
      "amountRecovered": 0,
      "substitutedByGuaranteeReference": "b3f1c2d4-5e6a-4b7c-8d9e-0f1a2b3c4d5e",
      "selfGuarantee": true,
      "declineReason": "string"
    }
  ],
  "description": "Guarantee requests retrieved successfully"
}

Responses

Status	When
`200`	Guarantee requests retrieved successfully

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