API reference · Pricing, reporting & reconciliation

Reconciliation report delivery

POST/reconciliation/definition/{code}/subscriptionSubscribe an audience to a reconciliation's reports
GET/reconciliation/definition/{code}/subscriptionsList a reconciliation's subscriptions
POST/reconciliation/report-link/{token}Consume a counterparty report link
GET/reconciliation/run/{reference}/deliveriesList the deliveries a run prepared

POST Subscribe an audience to a reconciliation's reports

POST /reconciliation/definition/{code}/subscription

A tenant audience receives the full report. An entity audience receives a counterparty extract and may receive nothing else - the scope is forced, not chosen, because a counterparty that can request the full report can read another counterparty's transaction records. The extract is filtered to that entity and then *asserted* to contain no trace of any other side: if the filter and the assertion ever disagree the delivery fails rather than being sent, on the grounds that the filter is the thing more likely to be wrong.

Headers

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

Path parameters

Name
`code`

Example

Request body: SubscribeReportRequest · Response: GenericResponseSubscriptionResponse

curl -X POST "https://api.bridgemoni.com/reconciliation/definition/value/subscription" \
  -H "Authorization: Bearer $BRIDGEMONI_TOKEN" \
  -H "X-Tenant: $BRIDGEMONI_TENANT" \
  -H "X-Environment: $BRIDGEMONI_ENV" \
  -H "Content-Type: application/json" \
  -d '{
  "audience": "string",
  "entityCode": "string",
  "deliveryChannel": "string",
  "artefactFormat": "string",
  "scope": "string",
  "destination": "string"
}'

{
  "audience": "string",
  "entityCode": "string",
  "deliveryChannel": "string",
  "artefactFormat": "string",
  "scope": "string",
  "destination": "string"
}

{
  "data": {
    "reference": "b3f1c2d4-5e6a-4b7c-8d9e-0f1a2b3c4d5e",
    "definitionCode": "string",
    "audience": "string",
    "entityCode": "string",
    "deliveryChannel": "string",
    "artefactFormat": "string",
    "scope": "string",
    "destination": "string",
    "active": true
  },
  "description": "Subscription created successfully"
}

Responses

Status	When
`200`	Subscription created successfully

GET List a reconciliation's subscriptions

GET /reconciliation/definition/{code}/subscriptions

Who receives this reconciliation's reports, by what channel and at what scope.

Headers

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

Path parameters

Name
`code`

Example

Response: GenericResponseListSubscriptionResponse

curl -X GET "https://api.bridgemoni.com/reconciliation/definition/value/subscriptions" \
  -H "Authorization: Bearer $BRIDGEMONI_TOKEN" \
  -H "X-Tenant: $BRIDGEMONI_TENANT" \
  -H "X-Environment: $BRIDGEMONI_ENV"

{
  "data": [
    {
      "reference": "b3f1c2d4-5e6a-4b7c-8d9e-0f1a2b3c4d5e",
      "definitionCode": "string",
      "audience": "string",
      "entityCode": "string",
      "deliveryChannel": "string",
      "artefactFormat": "string",
      "scope": "string",
      "destination": "string",
      "active": true
    }
  ],
  "description": "Subscriptions retrieved successfully"
}

Responses

Status	When
`200`	Subscriptions retrieved successfully

POST Consume a counterparty report link

POST /reconciliation/report-link/{token}

Returns the artefact and marks the link used. Links are single-use: one that works twice works for whoever else has seen it - a forwarded mail, a shared inbox, a browser history on a shared machine - and the artefact contains another party's transaction records. A withheld report's link returns the withholding rather than the report.

Headers

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

Path parameters

Name
`token`

Example

Response: GenericResponseDeliveryArtefactResponse

curl -X POST "https://api.bridgemoni.com/reconciliation/report-link/value" \
  -H "Authorization: Bearer $BRIDGEMONI_TOKEN" \
  -H "X-Tenant: $BRIDGEMONI_TENANT" \
  -H "X-Environment: $BRIDGEMONI_ENV"

{
  "data": {
    "reference": "b3f1c2d4-5e6a-4b7c-8d9e-0f1a2b3c4d5e",
    "runReference": "b3f1c2d4-5e6a-4b7c-8d9e-0f1a2b3c4d5e",
    "definitionCode": "string",
    "audience": "string",
    "entityCode": "string",
    "deliveryChannel": "string",
    "artefactFormat": "string",
    "scope": "string",
    "artefact": "string",
    "artefactHash": "string",
    "rowCount": 0,
    "status": "string",
    "linkToken": "string",
    "preparedAt": "string",
    "deliveredAt": "string",
    "consumedAt": "string",
    "consumedBy": "string",
    "failureReason": "string"
  },
  "description": "Report retrieved successfully"
}

Responses

Status	When
`200`	Report retrieved successfully

GET List the deliveries a run prepared

GET /reconciliation/run/{reference}/deliveries

A blocked run prepares no deliveries at all - a subscriber who receives a report over a period that was never compared will act on it as though it had been. A completed run whose charge is unmet prepares deliveries marked withheld, so the queue shows work that is done and waiting rather than work that never happened. The artefact itself is not returned here; only its hash and row count.

Headers

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

Path parameters

Name
`reference`

Example

Response: GenericResponseListDeliveryArtefactResponse

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

{
  "data": [
    {
      "reference": "b3f1c2d4-5e6a-4b7c-8d9e-0f1a2b3c4d5e",
      "runReference": "b3f1c2d4-5e6a-4b7c-8d9e-0f1a2b3c4d5e",
      "definitionCode": "string",
      "audience": "string",
      "entityCode": "string",
      "deliveryChannel": "string",
      "artefactFormat": "string",
      "scope": "string",
      "artefact": "string",
      "artefactHash": "string",
      "rowCount": 0,
      "status": "string",
      "linkToken": "string",
      "preparedAt": "string",
      "deliveredAt": "string",
      "consumedAt": "string",
      "consumedBy": "string",
      "failureReason": "string"
    }
  ],
  "description": "Deliveries retrieved successfully"
}

Responses

Status	When
`200`	Deliveries retrieved successfully

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