API reference · Communities & institutions

Credit union lifecycle and onboarding

POST/credit-union/{reference}/affiliate/{childReference}/graduationGraduate a child
POST/credit-union/{reference}/affiliate/{childReference}/onboardingAdvance a child's onboarding stage
GET/credit-union/{reference}/graduationRead the graduation checklist
GET/credit-union/{reference}/supervisionRead the mandates over this society
POST/credit-union/{reference}/supervisionGrant a supervision mandate over a child
DELETE/credit-union/{reference}/supervision/{mandateReference}Revoke a supervision mandate
POST/credit-union/{reference}/supervision/{mandateReference}/disclosureDisclose a mandate to the child's members
POST/credit-union/{reference}/supervision/{mandateReference}/extensionExtend a supervision mandate
POST/credit-union/{reference}/templatePublish a catalogue template
POST/credit-union/{reference}/template/{templateReference}/adoptAdopt a parent's catalogue template
GET/credit-union/{reference}/templatesList the templates this union publishes
POST/credit-union/{reference}/transfer/previewPreview a spin-out or an absorption
POST/credit-union/{reference}/transfer/{transferReference}/executionExecute a transfer
POST/credit-union/{reference}/transfer/{transferReference}/guarantee-resolutionResolve a stranded guarantee

POST Graduate a child

POST /credit-union/{reference}/affiliate/{childReference}/graduation

Revokes its supervision mandates explicitly, so the record shows the mandate ended because the society stood up rather than because a date passed.

Headers

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

Path parameters

Name
`reference`
`childReference`

Example

Response: GenericResponseGraduationChecklistResponse

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

{
  "data": {
    "childUnionReference": "b3f1c2d4-5e6a-4b7c-8d9e-0f1a2b3c4d5e",
    "parentUnionReference": "b3f1c2d4-5e6a-4b7c-8d9e-0f1a2b3c4d5e",
    "stage": "PROSPECT",
    "assessedOn": "2026-09-25",
    "criteria": [
      {
        "criterion": "MINIMUM_MEMBERS",
        "met": true,
        "observed": "string",
        "required": "string",
        "narrative": "string"
      }
    ],
    "eligible": true,
    "metCount": 0,
    "criteriaCount": 0
  },
  "description": "Society graduated successfully"
}

Responses

Status	When
`200`	Society graduated successfully

POST Advance a child's onboarding stage

POST /credit-union/{reference}/affiliate/{childReference}/onboarding

The child's status says what it is; the stage says how far along the onboarding it is. A refused move names the stages that do follow.

Headers

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

Path parameters

Name
`reference`
`childReference`

Query parameters

Name	Default
`stage`	Optional
`note`	Optional

Example

Response: GenericResponseString

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

{
  "data": "string",
  "description": "Onboarding advanced successfully"
}

Responses

Status	When
`200`	Onboarding advanced successfully

GET Read the graduation checklist

GET /credit-union/{reference}/graduation

Graduation is an event, not a date. A refusal that names nothing is a refusal nobody can act on, so every criterion is evaluated and reported.

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: GenericResponseGraduationChecklistResponse

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

{
  "data": {
    "childUnionReference": "b3f1c2d4-5e6a-4b7c-8d9e-0f1a2b3c4d5e",
    "parentUnionReference": "b3f1c2d4-5e6a-4b7c-8d9e-0f1a2b3c4d5e",
    "stage": "PROSPECT",
    "assessedOn": "2026-09-25",
    "criteria": [
      {
        "criterion": "MINIMUM_MEMBERS",
        "met": true,
        "observed": "string",
        "required": "string",
        "narrative": "string"
      }
    ],
    "eligible": true,
    "metCount": 0,
    "criteriaCount": 0
  },
  "description": "Graduation checklist retrieved successfully"
}

Responses

Status	When
`200`	Graduation checklist retrieved successfully

GET Read the mandates over this society

GET /credit-union/{reference}/supervision

Readable by every member of the child, and its board may contest them.

Headers

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

Path parameters

Name
`reference`

Example

Response: GenericResponseListSupervisionMandateResponse

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

{
  "data": [
    {
      "reference": "b3f1c2d4-5e6a-4b7c-8d9e-0f1a2b3c4d5e",
      "childUnionReference": "b3f1c2d4-5e6a-4b7c-8d9e-0f1a2b3c4d5e",
      "parentUnionReference": "b3f1c2d4-5e6a-4b7c-8d9e-0f1a2b3c4d5e",
      "grantedPermissions": [
        "string"
      ],
      "scope": "ALL",
      "thresholdAmount": 0,
      "basis": "CHARTER",
      "startsOn": "2026-09-25",
      "endsOn": "2026-09-25",
      "maximumExtensions": 0,
      "extensionCount": 0,
      "disclosedToChildAt": "2026-09-25T10:00:00Z",
      "status": "ACTIVE",
      "effectiveToday": true,
      "revokedAt": "2026-09-25T10:00:00Z",
      "revokedByUserReference": "b3f1c2d4-5e6a-4b7c-8d9e-0f1a2b3c4d5e",
      "revocationReason": "string",
      "resolutionDocumentReference": "b3f1c2d4-5e6a-4b7c-8d9e-0f1a2b3c4d5e"
    }
  ],
  "description": "Supervision mandates retrieved successfully"
}

Responses

Status	When
`200`	Supervision mandates retrieved successfully

POST Grant a supervision mandate over a child

POST /credit-union/{reference}/supervision

The one mechanism by which one union's officers ever act inside another's books. It names a direct child, lists its permissions one by one, and ends on a date.

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: GrantSupervisionRequest · Response: GenericResponseSupervisionMandateResponse

curl -X POST "https://api.bridgemoni.com/credit-union/b3f1c2d4-5e6a-4b7c-8d9e-0f1a2b3c4d5e/supervision" \
  -H "Authorization: Bearer $BRIDGEMONI_TOKEN" \
  -H "X-Tenant: $BRIDGEMONI_TENANT" \
  -H "X-Environment: $BRIDGEMONI_ENV" \
  -H "Content-Type: application/json" \
  -d '{
  "childUnionReference": "b3f1c2d4-5e6a-4b7c-8d9e-0f1a2b3c4d5e",
  "grantedPermissions": [
    "string"
  ],
  "scope": "ALL",
  "thresholdAmount": 0,
  "basis": "CHARTER",
  "startsOn": "2026-09-25",
  "endsOn": "2026-09-25",
  "maximumExtensions": 0,
  "resolutionDocumentReference": "b3f1c2d4-5e6a-4b7c-8d9e-0f1a2b3c4d5e"
}'

{
  "childUnionReference": "b3f1c2d4-5e6a-4b7c-8d9e-0f1a2b3c4d5e",
  "grantedPermissions": [
    "string"
  ],
  "scope": "ALL",
  "thresholdAmount": 0,
  "basis": "CHARTER",
  "startsOn": "2026-09-25",
  "endsOn": "2026-09-25",
  "maximumExtensions": 0,
  "resolutionDocumentReference": "b3f1c2d4-5e6a-4b7c-8d9e-0f1a2b3c4d5e"
}

{
  "data": {
    "reference": "b3f1c2d4-5e6a-4b7c-8d9e-0f1a2b3c4d5e",
    "childUnionReference": "b3f1c2d4-5e6a-4b7c-8d9e-0f1a2b3c4d5e",
    "parentUnionReference": "b3f1c2d4-5e6a-4b7c-8d9e-0f1a2b3c4d5e",
    "grantedPermissions": [
      "string"
    ],
    "scope": "ALL",
    "thresholdAmount": 0,
    "basis": "CHARTER",
    "startsOn": "2026-09-25",
    "endsOn": "2026-09-25",
    "maximumExtensions": 0,
    "extensionCount": 0,
    "disclosedToChildAt": "2026-09-25T10:00:00Z",
    "status": "ACTIVE",
    "effectiveToday": true,
    "revokedAt": "2026-09-25T10:00:00Z",
    "revokedByUserReference": "b3f1c2d4-5e6a-4b7c-8d9e-0f1a2b3c4d5e",
    "revocationReason": "string",
    "resolutionDocumentReference": "b3f1c2d4-5e6a-4b7c-8d9e-0f1a2b3c4d5e"
  },
  "description": "Supervision mandate granted successfully"
}

Responses

Status	When
`200`	Supervision mandate granted successfully

DELETE Revoke a supervision mandate

DELETE /credit-union/{reference}/supervision/{mandateReference}

Headers

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

Path parameters

Name
`reference`
`mandateReference`

Query parameters

Name	Default
`reason`	Optional

Example

Response: GenericResponseSupervisionMandateResponse

curl -X DELETE "https://api.bridgemoni.com/credit-union/b3f1c2d4-5e6a-4b7c-8d9e-0f1a2b3c4d5e/supervision/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",
    "childUnionReference": "b3f1c2d4-5e6a-4b7c-8d9e-0f1a2b3c4d5e",
    "parentUnionReference": "b3f1c2d4-5e6a-4b7c-8d9e-0f1a2b3c4d5e",
    "grantedPermissions": [
      "string"
    ],
    "scope": "ALL",
    "thresholdAmount": 0,
    "basis": "CHARTER",
    "startsOn": "2026-09-25",
    "endsOn": "2026-09-25",
    "maximumExtensions": 0,
    "extensionCount": 0,
    "disclosedToChildAt": "2026-09-25T10:00:00Z",
    "status": "ACTIVE",
    "effectiveToday": true,
    "revokedAt": "2026-09-25T10:00:00Z",
    "revokedByUserReference": "b3f1c2d4-5e6a-4b7c-8d9e-0f1a2b3c4d5e",
    "revocationReason": "string",
    "resolutionDocumentReference": "b3f1c2d4-5e6a-4b7c-8d9e-0f1a2b3c4d5e"
  },
  "description": "Supervision mandate revoked successfully"
}

Responses

Status	When
`200`	Supervision mandate revoked successfully

POST Disclose a mandate to the child's members

POST /credit-union/{reference}/supervision/{mandateReference}/disclosure

A mandate that has not been disclosed confers nothing.

Headers

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

Path parameters

Name
`reference`
`mandateReference`

Example

Response: GenericResponseSupervisionMandateResponse

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

{
  "data": {
    "reference": "b3f1c2d4-5e6a-4b7c-8d9e-0f1a2b3c4d5e",
    "childUnionReference": "b3f1c2d4-5e6a-4b7c-8d9e-0f1a2b3c4d5e",
    "parentUnionReference": "b3f1c2d4-5e6a-4b7c-8d9e-0f1a2b3c4d5e",
    "grantedPermissions": [
      "string"
    ],
    "scope": "ALL",
    "thresholdAmount": 0,
    "basis": "CHARTER",
    "startsOn": "2026-09-25",
    "endsOn": "2026-09-25",
    "maximumExtensions": 0,
    "extensionCount": 0,
    "disclosedToChildAt": "2026-09-25T10:00:00Z",
    "status": "ACTIVE",
    "effectiveToday": true,
    "revokedAt": "2026-09-25T10:00:00Z",
    "revokedByUserReference": "b3f1c2d4-5e6a-4b7c-8d9e-0f1a2b3c4d5e",
    "revocationReason": "string",
    "resolutionDocumentReference": "b3f1c2d4-5e6a-4b7c-8d9e-0f1a2b3c4d5e"
  },
  "description": "Supervision mandate disclosed successfully"
}

Responses

Status	When
`200`	Supervision mandate disclosed successfully

POST Extend a supervision mandate

POST /credit-union/{reference}/supervision/{mandateReference}/extension

An incubation that needs longer is an extension, capped and visible as such.

Headers

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

Path parameters

Name
`reference`
`mandateReference`

Query parameters

Name	Default
`endsOn`	Optional
`reason`	Optional

Example

Response: GenericResponseSupervisionMandateResponse

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

{
  "data": {
    "reference": "b3f1c2d4-5e6a-4b7c-8d9e-0f1a2b3c4d5e",
    "childUnionReference": "b3f1c2d4-5e6a-4b7c-8d9e-0f1a2b3c4d5e",
    "parentUnionReference": "b3f1c2d4-5e6a-4b7c-8d9e-0f1a2b3c4d5e",
    "grantedPermissions": [
      "string"
    ],
    "scope": "ALL",
    "thresholdAmount": 0,
    "basis": "CHARTER",
    "startsOn": "2026-09-25",
    "endsOn": "2026-09-25",
    "maximumExtensions": 0,
    "extensionCount": 0,
    "disclosedToChildAt": "2026-09-25T10:00:00Z",
    "status": "ACTIVE",
    "effectiveToday": true,
    "revokedAt": "2026-09-25T10:00:00Z",
    "revokedByUserReference": "b3f1c2d4-5e6a-4b7c-8d9e-0f1a2b3c4d5e",
    "revocationReason": "string",
    "resolutionDocumentReference": "b3f1c2d4-5e6a-4b7c-8d9e-0f1a2b3c4d5e"
  },
  "description": "Supervision mandate extended successfully"
}

Responses

Status	When
`200`	Supervision mandate extended successfully

POST Publish a catalogue template

POST /credit-union/{reference}/template

A parent does not configure its children. It publishes, and the child adopts by its own act; editing the template afterwards does not change any child's copy.

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: PublishTemplateRequest · Response: GenericResponseCatalogueTemplateResponse

curl -X POST "https://api.bridgemoni.com/credit-union/b3f1c2d4-5e6a-4b7c-8d9e-0f1a2b3c4d5e/template" \
  -H "Authorization: Bearer $BRIDGEMONI_TOKEN" \
  -H "X-Tenant: $BRIDGEMONI_TENANT" \
  -H "X-Environment: $BRIDGEMONI_ENV" \
  -H "Content-Type: application/json" \
  -d '{
  "kind": "LOAN_PRODUCT",
  "code": "string",
  "name": "string",
  "definition": {},
  "description": "string"
}'

{
  "kind": "LOAN_PRODUCT",
  "code": "string",
  "name": "string",
  "definition": {},
  "description": "string"
}

{
  "data": {
    "reference": "b3f1c2d4-5e6a-4b7c-8d9e-0f1a2b3c4d5e",
    "publishingUnionReference": "b3f1c2d4-5e6a-4b7c-8d9e-0f1a2b3c4d5e",
    "kind": "LOAN_PRODUCT",
    "code": "string",
    "name": "string",
    "description": "string",
    "definition": {},
    "status": "PUBLISHED",
    "version": 0,
    "publishedAt": "2026-09-25T10:00:00Z",
    "adoptionCount": 0,
    "adoptedFromTemplateReference": "b3f1c2d4-5e6a-4b7c-8d9e-0f1a2b3c4d5e"
  },
  "description": "Template published successfully"
}

Responses

Status	When
`200`	Template published successfully

POST Adopt a parent's catalogue template

POST /credit-union/{reference}/template/{templateReference}/adopt

Headers

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

Path parameters

Name
`reference`
`templateReference`

Example

Response: GenericResponseCatalogueTemplateResponse

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

{
  "data": {
    "reference": "b3f1c2d4-5e6a-4b7c-8d9e-0f1a2b3c4d5e",
    "publishingUnionReference": "b3f1c2d4-5e6a-4b7c-8d9e-0f1a2b3c4d5e",
    "kind": "LOAN_PRODUCT",
    "code": "string",
    "name": "string",
    "description": "string",
    "definition": {},
    "status": "PUBLISHED",
    "version": 0,
    "publishedAt": "2026-09-25T10:00:00Z",
    "adoptionCount": 0,
    "adoptedFromTemplateReference": "b3f1c2d4-5e6a-4b7c-8d9e-0f1a2b3c4d5e"
  },
  "description": "Template adopted successfully"
}

Responses

Status	When
`200`	Template adopted successfully

GET List the templates this union publishes

GET /credit-union/{reference}/templates

Headers

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

Path parameters

Name
`reference`

Example

Response: GenericResponseListCatalogueTemplateResponse

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

{
  "data": [
    {
      "reference": "b3f1c2d4-5e6a-4b7c-8d9e-0f1a2b3c4d5e",
      "publishingUnionReference": "b3f1c2d4-5e6a-4b7c-8d9e-0f1a2b3c4d5e",
      "kind": "LOAN_PRODUCT",
      "code": "string",
      "name": "string",
      "description": "string",
      "definition": {},
      "status": "PUBLISHED",
      "version": 0,
      "publishedAt": "2026-09-25T10:00:00Z",
      "adoptionCount": 0,
      "adoptedFromTemplateReference": "b3f1c2d4-5e6a-4b7c-8d9e-0f1a2b3c4d5e"
    }
  ],
  "description": "Templates retrieved successfully"
}

Responses

Status	When
`200`	Templates retrieved successfully

POST Preview a spin-out or an absorption

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

Enumerates every guarantee whose guarantor is not moving with its loan. The transfer is refused while any of them is unresolved.

Headers

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

Path parameters

Name
`reference`

Query parameters

Name	Default
`otherUnionReference`	Optional
`transferType`	Optional

Example

Response: GenericResponseSpinOutPreviewResponse

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

{
  "data": {
    "parentUnionReference": "b3f1c2d4-5e6a-4b7c-8d9e-0f1a2b3c4d5e",
    "branchUnionReference": "b3f1c2d4-5e6a-4b7c-8d9e-0f1a2b3c4d5e",
    "positionsMoving": 0,
    "depositAccountsMoving": 0,
    "loansMoving": 0,
    "shareCapitalMoving": 0,
    "depositsMoving": 0,
    "loanPortfolioMoving": 0,
    "strandedGuarantees": [
      {
        "guaranteeReference": "b3f1c2d4-5e6a-4b7c-8d9e-0f1a2b3c4d5e",
        "loanReference": "b3f1c2d4-5e6a-4b7c-8d9e-0f1a2b3c4d5e",
        "borrowerMemberNumber": "string",
        "guarantorPositionReference": "b3f1c2d4-5e6a-4b7c-8d9e-0f1a2b3c4d5e",
        "guarantorMemberNumber": "string",
        "amountGuaranteed": 0,
        "encumberedAmount": 0,
        "resolution": "SUBSTITUTE",
        "substituteGuarantorPositionReference": "b3f1c2d4-5e6a-4b7c-8d9e-0f1a2b3c4d5e",
        "note": "string",
        "resolved": true
      }
    ],
    "unresolvedCount": 0,
    "mayProceed": true,
    "blockers": [
      "string"
    ]
  },
  "description": "Transfer previewed successfully"
}

Responses

Status	When
`200`	Transfer previewed successfully

POST Execute a transfer

POST /credit-union/{reference}/transfer/{transferReference}/execution

Refused unless the control totals tie exactly on both sides. A carve-out or a merger that is out by any amount is a bug only a control-total comparison finds.

Headers

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

Path parameters

Name
`reference`
`transferReference`

Example

Request body: ExecuteTransferRequest · Response: GenericResponseUnionTransferResponse

curl -X POST "https://api.bridgemoni.com/credit-union/b3f1c2d4-5e6a-4b7c-8d9e-0f1a2b3c4d5e/transfer/b3f1c2d4-5e6a-4b7c-8d9e-0f1a2b3c4d5e/execution" \
  -H "Authorization: Bearer $BRIDGEMONI_TOKEN" \
  -H "X-Tenant: $BRIDGEMONI_TENANT" \
  -H "X-Environment: $BRIDGEMONI_ENV" \
  -H "Content-Type: application/json" \
  -d '{
  "memberVoteMinuteReference": "b3f1c2d4-5e6a-4b7c-8d9e-0f1a2b3c4d5e",
  "receivingUnionReference": "b3f1c2d4-5e6a-4b7c-8d9e-0f1a2b3c4d5e",
  "effectiveOn": "2026-09-25",
  "regulatorConsentReference": "b3f1c2d4-5e6a-4b7c-8d9e-0f1a2b3c4d5e",
  "note": "string"
}'

{
  "memberVoteMinuteReference": "b3f1c2d4-5e6a-4b7c-8d9e-0f1a2b3c4d5e",
  "receivingUnionReference": "b3f1c2d4-5e6a-4b7c-8d9e-0f1a2b3c4d5e",
  "effectiveOn": "2026-09-25",
  "regulatorConsentReference": "b3f1c2d4-5e6a-4b7c-8d9e-0f1a2b3c4d5e",
  "note": "string"
}

{
  "data": {
    "reference": "b3f1c2d4-5e6a-4b7c-8d9e-0f1a2b3c4d5e",
    "transferType": "TRANSFER_OF_ENGAGEMENTS",
    "fromUnionReference": "b3f1c2d4-5e6a-4b7c-8d9e-0f1a2b3c4d5e",
    "toUnionReference": "b3f1c2d4-5e6a-4b7c-8d9e-0f1a2b3c4d5e",
    "status": "PREVIEWED",
    "effectiveOn": "2026-09-25",
    "positionsMoved": 0,
    "loansMoved": 0,
    "depositAccountsMoved": 0,
    "membersMerged": 0,
    "controlTotals": {},
    "totalsTie": true,
    "discrepancy": 0,
    "memberVoteMinuteReference": "b3f1c2d4-5e6a-4b7c-8d9e-0f1a2b3c4d5e",
    "regulatorConsentReference": "b3f1c2d4-5e6a-4b7c-8d9e-0f1a2b3c4d5e",
    "executedAt": "2026-09-25T10:00:00Z",
    "executedByUserReference": "b3f1c2d4-5e6a-4b7c-8d9e-0f1a2b3c4d5e",
    "exceptions": [
      "string"
    ]
  },
  "description": "Transfer executed successfully"
}

Responses

Status	When
`200`	Transfer executed successfully

POST Resolve a stranded guarantee

POST /credit-union/{reference}/transfer/{transferReference}/guarantee-resolution

Substitute a guarantor who is moving, retain the loan at the parent as a recorded exception, or release and re-secure with a deadline.

Headers

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

Path parameters

Name
`reference`
`transferReference`

Example

Request body: ResolveStrandedGuaranteeRequest · Response: GenericResponseStrandedGuaranteeResponse

curl -X POST "https://api.bridgemoni.com/credit-union/b3f1c2d4-5e6a-4b7c-8d9e-0f1a2b3c4d5e/transfer/b3f1c2d4-5e6a-4b7c-8d9e-0f1a2b3c4d5e/guarantee-resolution" \
  -H "Authorization: Bearer $BRIDGEMONI_TOKEN" \
  -H "X-Tenant: $BRIDGEMONI_TENANT" \
  -H "X-Environment: $BRIDGEMONI_ENV" \
  -H "Content-Type: application/json" \
  -d '{
  "guaranteeReference": "b3f1c2d4-5e6a-4b7c-8d9e-0f1a2b3c4d5e",
  "resolution": "SUBSTITUTE",
  "substituteGuarantorPositionReference": "b3f1c2d4-5e6a-4b7c-8d9e-0f1a2b3c4d5e",
  "remediationDueOn": "2026-09-25",
  "note": "string"
}'

{
  "guaranteeReference": "b3f1c2d4-5e6a-4b7c-8d9e-0f1a2b3c4d5e",
  "resolution": "SUBSTITUTE",
  "substituteGuarantorPositionReference": "b3f1c2d4-5e6a-4b7c-8d9e-0f1a2b3c4d5e",
  "remediationDueOn": "2026-09-25",
  "note": "string"
}

{
  "data": {
    "guaranteeReference": "b3f1c2d4-5e6a-4b7c-8d9e-0f1a2b3c4d5e",
    "loanReference": "b3f1c2d4-5e6a-4b7c-8d9e-0f1a2b3c4d5e",
    "borrowerMemberNumber": "string",
    "guarantorPositionReference": "b3f1c2d4-5e6a-4b7c-8d9e-0f1a2b3c4d5e",
    "guarantorMemberNumber": "string",
    "amountGuaranteed": 0,
    "encumberedAmount": 0,
    "resolution": "SUBSTITUTE",
    "substituteGuarantorPositionReference": "b3f1c2d4-5e6a-4b7c-8d9e-0f1a2b3c4d5e",
    "note": "string",
    "resolved": true
  },
  "description": "Stranded guarantee resolved successfully"
}

Responses

Status	When
`200`	Stranded guarantee resolved successfully

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