Bridge
Contact us
API reference · Communities & institutions

Credit union shared branching

GET List this society's inter-society settlements

GET /credit-union/{reference}/inter-society-settlements

Both sides of the relationship: what this society owes for money it took at its own counter, and what is owed to it for money its members paid in elsewhere.

Headers

NameNotes
AuthorizationBearer token
X-TenantYour tenant
X-Environmenttest or live

Path parameters

Name
reference

Example

Response: GenericResponseListInterSocietySettlementResponse

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

Responses

StatusWhen
200Inter-society settlements retrieved successfully

POST Take a guest member's deposit at this society's counter

POST /credit-union/{reference}/shared-branch/deposit

The cash lands in the acquirer's operating pocket against a payable to the member's own society; the acquirer's deposit pocket is never touched, because the money is not its members'. The member is credited at their own society value-dated to this transaction, not to the settlement.

Headers

NameNotes
AuthorizationBearer token
X-TenantYour tenant
X-Environmenttest or live
Content-Typeapplication/json

Path parameters

Name
reference

Example

Request body: SharedBranchDepositRequest · Response: GenericResponseSharedBranchDepositResponse

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

Responses

StatusWhen
200Shared-branch deposit taken successfully

POST Join a shared-branching network

POST /credit-union/{reference}/shared-branching/participant

Shared branching is peer-to-peer, so the adjacency rule that bounds parent-child flows does not apply. It is bounded instead by explicit membership of a named network: a society outside it is refused at the counter.

Headers

NameNotes
AuthorizationBearer token
X-TenantYour tenant
X-Environmenttest or live
Content-Typeapplication/json

Path parameters

Name
reference

Example

Request body: JoinSharedBranchingNetworkRequest · Response: GenericResponseSharedBranchingParticipantResponse

curl -X POST "https://api.bridgemoni.com/credit-union/b3f1c2d4-5e6a-4b7c-8d9e-0f1a2b3c4d5e/shared-branching/participant" \
  -H "Authorization: Bearer $BRIDGEMONI_TOKEN" \
  -H "X-Tenant: $BRIDGEMONI_TENANT" \
  -H "X-Environment: $BRIDGEMONI_ENV" \
  -H "Content-Type: application/json" \
  -d '{
  "networkCode": "string",
  "networkName": "string",
  "sponsorUnionReference": "b3f1c2d4-5e6a-4b7c-8d9e-0f1a2b3c4d5e",
  "agreementDocumentReference": "b3f1c2d4-5e6a-4b7c-8d9e-0f1a2b3c4d5e",
  "joinedOn": "2026-09-25"
}'

Responses

StatusWhen
200Shared-branching network joined successfully

DELETE Leave a shared-branching network

DELETE /credit-union/{reference}/shared-branching/participant/{networkCode}

Deposits already taken still settle. Leaving stops the next one being accepted, it does not cancel money a member has already handed over.

Headers

NameNotes
AuthorizationBearer token
X-TenantYour tenant
X-Environmenttest or live

Path parameters

Name
reference
networkCode

Query parameters

NameDefault
leftOnOptional

Example

Response: GenericResponseSharedBranchingParticipantResponse

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

Responses

StatusWhen
200Shared-branching network left successfully

POST Suspend a society's participation in a network

POST /credit-union/{reference}/shared-branching/participant/{networkCode}/suspension

A suspended participant is neither served nor serves, and may be reinstated.

Headers

NameNotes
AuthorizationBearer token
X-TenantYour tenant
X-Environmenttest or live

Path parameters

Name
reference
networkCode

Query parameters

NameDefault
reasonOptional

Example

Response: GenericResponseSharedBranchingParticipantResponse

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

Responses

StatusWhen
200Shared-branching participation suspended successfully

GET List the networks this society is in

GET /credit-union/{reference}/shared-branching/participants

Headers

NameNotes
AuthorizationBearer token
X-TenantYour tenant
X-Environmenttest or live

Path parameters

Name
reference

Example

Response: GenericResponseListSharedBranchingParticipantResponse

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

Responses

StatusWhen
200Shared-branching participation retrieved successfully

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