API reference · Communities & institutions

Credit union surplus and distributions

POST/credit-union/{reference}/allocation/{allocationReference}/claimRecord that a member claimed a held allocation
POST/credit-union/{reference}/appropriationApply the statutory appropriation
POST/credit-union/{reference}/appropriation/proposalPropose the statutory appropriation
GET/credit-union/{reference}/appropriation/{fiscalYear}Read a year's appropriation
POST/credit-union/{reference}/distributionDeclare a distribution
DELETE/credit-union/{reference}/distribution/{distributionReference}Cancel a distribution that has not been paid
GET/credit-union/{reference}/distribution/{distributionReference}Read one distribution
GET/credit-union/{reference}/distribution/{distributionReference}/allocationsRead the per-member allocations of a distribution
POST/credit-union/{reference}/distribution/{distributionReference}/approvalApprove a distribution
POST/credit-union/{reference}/distribution/{distributionReference}/destinationElect where a member's allocation is paid
POST/credit-union/{reference}/distribution/{distributionReference}/paymentPay an approved distribution
GET/credit-union/{reference}/distributionsList this union's distributions
GET/credit-union/{reference}/report/unclaimed-distributionsRead the unclaimed distribution register

POST Record that a member claimed a held allocation

POST /credit-union/{reference}/allocation/{allocationReference}/claim

Headers

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

Path parameters

Name
`reference`
`allocationReference`

Query parameters

Name	Default
`transactionReference`	Optional

Example

Response: GenericResponseDistributionAllocationResponse

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

{
  "data": {
    "reference": "b3f1c2d4-5e6a-4b7c-8d9e-0f1a2b3c4d5e",
    "distributionReference": "b3f1c2d4-5e6a-4b7c-8d9e-0f1a2b3c4d5e",
    "positionReference": "b3f1c2d4-5e6a-4b7c-8d9e-0f1a2b3c4d5e",
    "memberNumber": "string",
    "membershipClassCode": "string",
    "basisAmount": 0,
    "grossAmount": 0,
    "withholdingAmount": 0,
    "netAmount": 0,
    "destination": "SHARES",
    "status": "PENDING",
    "financialTransactionReference": "b3f1c2d4-5e6a-4b7c-8d9e-0f1a2b3c4d5e",
    "unpayableReason": "string"
  },
  "description": "Allocation claimed successfully"
}

Responses

Status	When
`200`	Allocation claimed successfully

POST Apply the statutory appropriation

POST /credit-union/{reference}/appropriation

Writes a journal per fund out of retained surplus. What is left after every fund has taken its share is what a dividend or a rebate may be declared against.

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: ProposeAppropriationRequest · Response: GenericResponseAppropriationRunResponse

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

{
  "fiscalYear": 0,
  "ratesBasisPoints": {},
  "resolutionReference": "b3f1c2d4-5e6a-4b7c-8d9e-0f1a2b3c4d5e"
}

{
  "data": {
    "unionReference": "b3f1c2d4-5e6a-4b7c-8d9e-0f1a2b3c4d5e",
    "fiscalYear": 0,
    "currencyCode": "string",
    "netSurplus": 0,
    "lines": [
      {
        "reference": "b3f1c2d4-5e6a-4b7c-8d9e-0f1a2b3c4d5e",
        "fundCode": "RESERVE_FUND",
        "sequence": 0,
        "basisBasisPoints": 0,
        "minimumBasisPoints": 0,
        "maximumBasisPoints": 0,
        "amount": 0,
        "appliedTo": 0,
        "remainingAfter": 0,
        "glAccountCode": "string",
        "status": "PROPOSED"
      }
    ],
    "totalAppropriated": 0,
    "distributableSurplus": 0,
    "applied": true,
    "appliedAt": "2026-09-25T10:00:00Z",
    "refusals": [
      "string"
    ]
  },
  "description": "Appropriation applied successfully"
}

Responses

Status	When
`200`	Appropriation applied successfully

POST Propose the statutory appropriation

POST /credit-union/{reference}/appropriation/proposal

Runs the sequence without writing it. Each step applies to what the step before it left, and a fund outside its statutory floor or ceiling is named in the refusals rather than clamped.

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: ProposeAppropriationRequest · Response: GenericResponseAppropriationRunResponse

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

{
  "fiscalYear": 0,
  "ratesBasisPoints": {},
  "resolutionReference": "b3f1c2d4-5e6a-4b7c-8d9e-0f1a2b3c4d5e"
}

{
  "data": {
    "unionReference": "b3f1c2d4-5e6a-4b7c-8d9e-0f1a2b3c4d5e",
    "fiscalYear": 0,
    "currencyCode": "string",
    "netSurplus": 0,
    "lines": [
      {
        "reference": "b3f1c2d4-5e6a-4b7c-8d9e-0f1a2b3c4d5e",
        "fundCode": "RESERVE_FUND",
        "sequence": 0,
        "basisBasisPoints": 0,
        "minimumBasisPoints": 0,
        "maximumBasisPoints": 0,
        "amount": 0,
        "appliedTo": 0,
        "remainingAfter": 0,
        "glAccountCode": "string",
        "status": "PROPOSED"
      }
    ],
    "totalAppropriated": 0,
    "distributableSurplus": 0,
    "applied": true,
    "appliedAt": "2026-09-25T10:00:00Z",
    "refusals": [
      "string"
    ]
  },
  "description": "Appropriation proposed successfully"
}

Responses

Status	When
`200`	Appropriation proposed successfully

GET Read a year's appropriation

GET /credit-union/{reference}/appropriation/{fiscalYear}

Headers

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

Path parameters

Name
`reference`
`fiscalYear`

Example

Response: GenericResponseAppropriationRunResponse

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

{
  "data": {
    "unionReference": "b3f1c2d4-5e6a-4b7c-8d9e-0f1a2b3c4d5e",
    "fiscalYear": 0,
    "currencyCode": "string",
    "netSurplus": 0,
    "lines": [
      {
        "reference": "b3f1c2d4-5e6a-4b7c-8d9e-0f1a2b3c4d5e",
        "fundCode": "RESERVE_FUND",
        "sequence": 0,
        "basisBasisPoints": 0,
        "minimumBasisPoints": 0,
        "maximumBasisPoints": 0,
        "amount": 0,
        "appliedTo": 0,
        "remainingAfter": 0,
        "glAccountCode": "string",
        "status": "PROPOSED"
      }
    ],
    "totalAppropriated": 0,
    "distributableSurplus": 0,
    "applied": true,
    "appliedAt": "2026-09-25T10:00:00Z",
    "refusals": [
      "string"
    ]
  },
  "description": "Appropriation retrieved successfully"
}

Responses

Status	When
`200`	Appropriation retrieved successfully

POST Declare a distribution

POST /credit-union/{reference}/distribution

One rate for everyone entitled. The surplus is read from the closed year's books, not supplied, and a rate that would overspend it is refused. Allocation is on share-unit days, deposit amount-days or interest actually paid.

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: DeclareDistributionRequest · Response: GenericResponseDistributionResponse

curl -X POST "https://api.bridgemoni.com/credit-union/b3f1c2d4-5e6a-4b7c-8d9e-0f1a2b3c4d5e/distribution" \
  -H "Authorization: Bearer $BRIDGEMONI_TOKEN" \
  -H "X-Tenant: $BRIDGEMONI_TENANT" \
  -H "X-Environment: $BRIDGEMONI_ENV" \
  -H "Content-Type: application/json" \
  -d '{
  "type": "SHARE_DIVIDEND",
  "fiscalYear": 0,
  "rateBasisPoints": 0,
  "agmMinuteReference": "b3f1c2d4-5e6a-4b7c-8d9e-0f1a2b3c4d5e",
  "defaultDestination": "SHARES",
  "withholdingPolicyCode": "string",
  "withholdingBasisPoints": 0
}'

{
  "type": "SHARE_DIVIDEND",
  "fiscalYear": 0,
  "rateBasisPoints": 0,
  "agmMinuteReference": "b3f1c2d4-5e6a-4b7c-8d9e-0f1a2b3c4d5e",
  "defaultDestination": "SHARES",
  "withholdingPolicyCode": "string",
  "withholdingBasisPoints": 0
}

{
  "data": {
    "reference": "b3f1c2d4-5e6a-4b7c-8d9e-0f1a2b3c4d5e",
    "unionReference": "b3f1c2d4-5e6a-4b7c-8d9e-0f1a2b3c4d5e",
    "type": "SHARE_DIVIDEND",
    "basis": "SHARE_UNIT_DAYS",
    "fiscalYear": 0,
    "periodStart": "2026-09-25",
    "periodEnd": "2026-09-25",
    "currencyCode": "string",
    "declaredRateBasisPoints": 0,
    "distributableSurplus": 0,
    "totalBasis": 0,
    "totalAllocated": 0,
    "totalWithheld": 0,
    "residualToReserve": 0,
    "status": "DRAFT",
    "defaultDestination": "SHARES",
    "withholdingPolicyCode": "string",
    "withholdingBasisPoints": 0,
    "agmMinuteReference": "b3f1c2d4-5e6a-4b7c-8d9e-0f1a2b3c4d5e",
    "approvalsRequired": 0,
    "approvalsGiven": 0,
    "declaredByUserReference": "b3f1c2d4-5e6a-4b7c-8d9e-0f1a2b3c4d5e",
    "declaredAt": "2026-09-25T10:00:00Z",
    "approvedAt": "2026-09-25T10:00:00Z",
    "paidAt": "2026-09-25T10:00:00Z",
    "journalReference": "b3f1c2d4-5e6a-4b7c-8d9e-0f1a2b3c4d5e",
    "recipientCount": 0,
    "refusals": [
      "string"
    ]
  },
  "description": "Distribution declared successfully"
}

Responses

Status	When
`200`	Distribution declared successfully

DELETE Cancel a distribution that has not been paid

DELETE /credit-union/{reference}/distribution/{distributionReference}

Headers

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

Path parameters

Name
`reference`
`distributionReference`

Query parameters

Name	Default
`reason`	Optional

Example

Response: GenericResponseDistributionResponse

curl -X DELETE "https://api.bridgemoni.com/credit-union/b3f1c2d4-5e6a-4b7c-8d9e-0f1a2b3c4d5e/distribution/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",
    "unionReference": "b3f1c2d4-5e6a-4b7c-8d9e-0f1a2b3c4d5e",
    "type": "SHARE_DIVIDEND",
    "basis": "SHARE_UNIT_DAYS",
    "fiscalYear": 0,
    "periodStart": "2026-09-25",
    "periodEnd": "2026-09-25",
    "currencyCode": "string",
    "declaredRateBasisPoints": 0,
    "distributableSurplus": 0,
    "totalBasis": 0,
    "totalAllocated": 0,
    "totalWithheld": 0,
    "residualToReserve": 0,
    "status": "DRAFT",
    "defaultDestination": "SHARES",
    "withholdingPolicyCode": "string",
    "withholdingBasisPoints": 0,
    "agmMinuteReference": "b3f1c2d4-5e6a-4b7c-8d9e-0f1a2b3c4d5e",
    "approvalsRequired": 0,
    "approvalsGiven": 0,
    "declaredByUserReference": "b3f1c2d4-5e6a-4b7c-8d9e-0f1a2b3c4d5e",
    "declaredAt": "2026-09-25T10:00:00Z",
    "approvedAt": "2026-09-25T10:00:00Z",
    "paidAt": "2026-09-25T10:00:00Z",
    "journalReference": "b3f1c2d4-5e6a-4b7c-8d9e-0f1a2b3c4d5e",
    "recipientCount": 0,
    "refusals": [
      "string"
    ]
  },
  "description": "Distribution cancelled successfully"
}

Responses

Status	When
`200`	Distribution cancelled successfully

GET Read one distribution

GET /credit-union/{reference}/distribution/{distributionReference}

Headers

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

Path parameters

Name
`reference`
`distributionReference`

Example

Response: GenericResponseDistributionResponse

curl -X GET "https://api.bridgemoni.com/credit-union/b3f1c2d4-5e6a-4b7c-8d9e-0f1a2b3c4d5e/distribution/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",
    "unionReference": "b3f1c2d4-5e6a-4b7c-8d9e-0f1a2b3c4d5e",
    "type": "SHARE_DIVIDEND",
    "basis": "SHARE_UNIT_DAYS",
    "fiscalYear": 0,
    "periodStart": "2026-09-25",
    "periodEnd": "2026-09-25",
    "currencyCode": "string",
    "declaredRateBasisPoints": 0,
    "distributableSurplus": 0,
    "totalBasis": 0,
    "totalAllocated": 0,
    "totalWithheld": 0,
    "residualToReserve": 0,
    "status": "DRAFT",
    "defaultDestination": "SHARES",
    "withholdingPolicyCode": "string",
    "withholdingBasisPoints": 0,
    "agmMinuteReference": "b3f1c2d4-5e6a-4b7c-8d9e-0f1a2b3c4d5e",
    "approvalsRequired": 0,
    "approvalsGiven": 0,
    "declaredByUserReference": "b3f1c2d4-5e6a-4b7c-8d9e-0f1a2b3c4d5e",
    "declaredAt": "2026-09-25T10:00:00Z",
    "approvedAt": "2026-09-25T10:00:00Z",
    "paidAt": "2026-09-25T10:00:00Z",
    "journalReference": "b3f1c2d4-5e6a-4b7c-8d9e-0f1a2b3c4d5e",
    "recipientCount": 0,
    "refusals": [
      "string"
    ]
  },
  "description": "Distribution retrieved successfully"
}

Responses

Status	When
`200`	Distribution retrieved successfully

GET Read the per-member allocations of a distribution

GET /credit-union/{reference}/distribution/{distributionReference}/allocations

Headers

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

Path parameters

Name
`reference`
`distributionReference`

Example

Response: GenericResponseListDistributionAllocationResponse

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

{
  "data": [
    {
      "reference": "b3f1c2d4-5e6a-4b7c-8d9e-0f1a2b3c4d5e",
      "distributionReference": "b3f1c2d4-5e6a-4b7c-8d9e-0f1a2b3c4d5e",
      "positionReference": "b3f1c2d4-5e6a-4b7c-8d9e-0f1a2b3c4d5e",
      "memberNumber": "string",
      "membershipClassCode": "string",
      "basisAmount": 0,
      "grossAmount": 0,
      "withholdingAmount": 0,
      "netAmount": 0,
      "destination": "SHARES",
      "status": "PENDING",
      "financialTransactionReference": "b3f1c2d4-5e6a-4b7c-8d9e-0f1a2b3c4d5e",
      "unpayableReason": "string"
    }
  ],
  "description": "Allocations retrieved successfully"
}

Responses

Status	When
`200`	Allocations retrieved successfully

POST Approve a distribution

POST /credit-union/{reference}/distribution/{distributionReference}/approval

The member who declared it may not approve it.

Headers

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

Path parameters

Name
`reference`
`distributionReference`

Example

Request body: ApproveDistributionRequest · Response: GenericResponseDistributionResponse

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

{
  "note": "string"
}

{
  "data": {
    "reference": "b3f1c2d4-5e6a-4b7c-8d9e-0f1a2b3c4d5e",
    "unionReference": "b3f1c2d4-5e6a-4b7c-8d9e-0f1a2b3c4d5e",
    "type": "SHARE_DIVIDEND",
    "basis": "SHARE_UNIT_DAYS",
    "fiscalYear": 0,
    "periodStart": "2026-09-25",
    "periodEnd": "2026-09-25",
    "currencyCode": "string",
    "declaredRateBasisPoints": 0,
    "distributableSurplus": 0,
    "totalBasis": 0,
    "totalAllocated": 0,
    "totalWithheld": 0,
    "residualToReserve": 0,
    "status": "DRAFT",
    "defaultDestination": "SHARES",
    "withholdingPolicyCode": "string",
    "withholdingBasisPoints": 0,
    "agmMinuteReference": "b3f1c2d4-5e6a-4b7c-8d9e-0f1a2b3c4d5e",
    "approvalsRequired": 0,
    "approvalsGiven": 0,
    "declaredByUserReference": "b3f1c2d4-5e6a-4b7c-8d9e-0f1a2b3c4d5e",
    "declaredAt": "2026-09-25T10:00:00Z",
    "approvedAt": "2026-09-25T10:00:00Z",
    "paidAt": "2026-09-25T10:00:00Z",
    "journalReference": "b3f1c2d4-5e6a-4b7c-8d9e-0f1a2b3c4d5e",
    "recipientCount": 0,
    "refusals": [
      "string"
    ]
  },
  "description": "Distribution approved successfully"
}

Responses

Status	When
`200`	Distribution approved successfully

POST Elect where a member's allocation is paid

POST /credit-union/{reference}/distribution/{distributionReference}/destination

The default is capitalisation back to shares, not cash.

Headers

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

Path parameters

Name
`reference`
`distributionReference`

Example

Request body: ElectDestinationRequest · Response: GenericResponseDistributionAllocationResponse

curl -X POST "https://api.bridgemoni.com/credit-union/b3f1c2d4-5e6a-4b7c-8d9e-0f1a2b3c4d5e/distribution/b3f1c2d4-5e6a-4b7c-8d9e-0f1a2b3c4d5e/destination" \
  -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",
  "destination": "SHARES"
}'

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

{
  "data": {
    "reference": "b3f1c2d4-5e6a-4b7c-8d9e-0f1a2b3c4d5e",
    "distributionReference": "b3f1c2d4-5e6a-4b7c-8d9e-0f1a2b3c4d5e",
    "positionReference": "b3f1c2d4-5e6a-4b7c-8d9e-0f1a2b3c4d5e",
    "memberNumber": "string",
    "membershipClassCode": "string",
    "basisAmount": 0,
    "grossAmount": 0,
    "withholdingAmount": 0,
    "netAmount": 0,
    "destination": "SHARES",
    "status": "PENDING",
    "financialTransactionReference": "b3f1c2d4-5e6a-4b7c-8d9e-0f1a2b3c4d5e",
    "unpayableReason": "string"
  },
  "description": "Destination elected successfully"
}

Responses

Status	When
`200`	Destination elected successfully

POST Pay an approved distribution

POST /credit-union/{reference}/distribution/{distributionReference}/payment

A member who cannot be paid leaves the allocation as a liability of the union rather than losing it, and it is never swept into reserve.

Headers

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

Path parameters

Name
`reference`
`distributionReference`

Example

Response: GenericResponseDistributionResponse

curl -X POST "https://api.bridgemoni.com/credit-union/b3f1c2d4-5e6a-4b7c-8d9e-0f1a2b3c4d5e/distribution/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",
    "unionReference": "b3f1c2d4-5e6a-4b7c-8d9e-0f1a2b3c4d5e",
    "type": "SHARE_DIVIDEND",
    "basis": "SHARE_UNIT_DAYS",
    "fiscalYear": 0,
    "periodStart": "2026-09-25",
    "periodEnd": "2026-09-25",
    "currencyCode": "string",
    "declaredRateBasisPoints": 0,
    "distributableSurplus": 0,
    "totalBasis": 0,
    "totalAllocated": 0,
    "totalWithheld": 0,
    "residualToReserve": 0,
    "status": "DRAFT",
    "defaultDestination": "SHARES",
    "withholdingPolicyCode": "string",
    "withholdingBasisPoints": 0,
    "agmMinuteReference": "b3f1c2d4-5e6a-4b7c-8d9e-0f1a2b3c4d5e",
    "approvalsRequired": 0,
    "approvalsGiven": 0,
    "declaredByUserReference": "b3f1c2d4-5e6a-4b7c-8d9e-0f1a2b3c4d5e",
    "declaredAt": "2026-09-25T10:00:00Z",
    "approvedAt": "2026-09-25T10:00:00Z",
    "paidAt": "2026-09-25T10:00:00Z",
    "journalReference": "b3f1c2d4-5e6a-4b7c-8d9e-0f1a2b3c4d5e",
    "recipientCount": 0,
    "refusals": [
      "string"
    ]
  },
  "description": "Distribution paid successfully"
}

Responses

Status	When
`200`	Distribution paid successfully

GET List this union's distributions

GET /credit-union/{reference}/distributions

Headers

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

Path parameters

Name
`reference`

Example

Response: GenericResponseListDistributionResponse

curl -X GET "https://api.bridgemoni.com/credit-union/b3f1c2d4-5e6a-4b7c-8d9e-0f1a2b3c4d5e/distributions" \
  -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",
      "type": "SHARE_DIVIDEND",
      "basis": "SHARE_UNIT_DAYS",
      "fiscalYear": 0,
      "periodStart": "2026-09-25",
      "periodEnd": "2026-09-25",
      "currencyCode": "string",
      "declaredRateBasisPoints": 0,
      "distributableSurplus": 0,
      "totalBasis": 0,
      "totalAllocated": 0,
      "totalWithheld": 0,
      "residualToReserve": 0,
      "status": "DRAFT",
      "defaultDestination": "SHARES",
      "withholdingPolicyCode": "string",
      "withholdingBasisPoints": 0,
      "agmMinuteReference": "b3f1c2d4-5e6a-4b7c-8d9e-0f1a2b3c4d5e",
      "approvalsRequired": 0,
      "approvalsGiven": 0,
      "declaredByUserReference": "b3f1c2d4-5e6a-4b7c-8d9e-0f1a2b3c4d5e",
      "declaredAt": "2026-09-25T10:00:00Z",
      "approvedAt": "2026-09-25T10:00:00Z",
      "paidAt": "2026-09-25T10:00:00Z",
      "journalReference": "b3f1c2d4-5e6a-4b7c-8d9e-0f1a2b3c4d5e",
      "recipientCount": 0,
      "refusals": [
        "string"
      ]
    }
  ],
  "description": "Distributions retrieved successfully"
}

Responses

Status	When
`200`	Distributions retrieved successfully

GET Read the unclaimed distribution register

GET /credit-union/{reference}/report/unclaimed-distributions

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

curl -X GET "https://api.bridgemoni.com/credit-union/b3f1c2d4-5e6a-4b7c-8d9e-0f1a2b3c4d5e/report/unclaimed-distributions" \
  -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",
    "count": 0,
    "totalUnclaimed": 0,
    "oldestAgeInDays": 0,
    "allocations": [
      {
        "reference": "b3f1c2d4-5e6a-4b7c-8d9e-0f1a2b3c4d5e",
        "distributionReference": "b3f1c2d4-5e6a-4b7c-8d9e-0f1a2b3c4d5e",
        "positionReference": "b3f1c2d4-5e6a-4b7c-8d9e-0f1a2b3c4d5e",
        "memberNumber": "string",
        "membershipClassCode": "string",
        "basisAmount": 0,
        "grossAmount": 0,
        "withholdingAmount": 0,
        "netAmount": 0,
        "destination": "SHARES",
        "status": "PENDING",
        "financialTransactionReference": "b3f1c2d4-5e6a-4b7c-8d9e-0f1a2b3c4d5e",
        "unpayableReason": "string"
      }
    ]
  },
  "description": "Unclaimed distributions retrieved successfully"
}

Responses

Status	When
`200`	Unclaimed distributions retrieved successfully

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