API reference · Pricing, reporting & reconciliation

Reconciliation charges

GET/reconciliation/charges/withheldList reports being withheld for want of funds
GET/reconciliation/definition/{code}/chargesList a definition's charges
GET/reconciliation/run/{reference}/chargeRead the charge a report raised
POST/reconciliation/run/{reference}/charge/settleSettle a withheld charge after funding the account

GET List reports being withheld for want of funds

GET /reconciliation/charges/withheld

Work that has been done and is not yet released. This queue is the honest measure of prepaid friction: a customer whose reports sit here is one whose funding cadence does not match their reconciliation cadence, which is a commercial conversation rather than a technical fault.

Headers

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

Example

Response: GenericResponseListChargeResponse

curl -X GET "https://api.bridgemoni.com/reconciliation/charges/withheld" \
  -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",
      "certificateReference": "b3f1c2d4-5e6a-4b7c-8d9e-0f1a2b3c4d5e",
      "definitionCode": "string",
      "chargeBearer": "string",
      "bearerEntityCode": "string",
      "billingAccountNumber": "string",
      "billableRecords": 0,
      "bandLabel": "string",
      "amount": "string",
      "currencyCode": "string",
      "status": "string",
      "withheld": true,
      "shortfall": "string",
      "settlementReference": "b3f1c2d4-5e6a-4b7c-8d9e-0f1a2b3c4d5e",
      "raisedAt": "string",
      "settledAt": "string",
      "attempts": 0,
      "failureReason": "string"
    }
  ],
  "description": "Withheld reports retrieved successfully"
}

Responses

Status	When
`200`	Withheld reports retrieved successfully

GET List a definition's charges

GET /reconciliation/definition/{code}/charges

Every report this reconciliation has produced and what each cost.

Headers

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

Path parameters

Name
`code`

Example

Response: GenericResponseListChargeResponse

curl -X GET "https://api.bridgemoni.com/reconciliation/definition/value/charges" \
  -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",
      "certificateReference": "b3f1c2d4-5e6a-4b7c-8d9e-0f1a2b3c4d5e",
      "definitionCode": "string",
      "chargeBearer": "string",
      "bearerEntityCode": "string",
      "billingAccountNumber": "string",
      "billableRecords": 0,
      "bandLabel": "string",
      "amount": "string",
      "currencyCode": "string",
      "status": "string",
      "withheld": true,
      "shortfall": "string",
      "settlementReference": "b3f1c2d4-5e6a-4b7c-8d9e-0f1a2b3c4d5e",
      "raisedAt": "string",
      "settledAt": "string",
      "attempts": 0,
      "failureReason": "string"
    }
  ],
  "description": "Charges retrieved successfully"
}

Responses

Status	When
`200`	Charges retrieved successfully

GET Read the charge a report raised

GET /reconciliation/run/{reference}/charge

A charge crystallises when a report completes - never when records arrive, never on a run that blocked, and never on a re-run that supersedes an earlier report for the same period. It is priced in bands by the number of billable records, so an entity funding an account in advance knows what next month costs without doing arithmetic.

Headers

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

Path parameters

Name
`reference`

Example

Response: GenericResponseChargeResponse

curl -X GET "https://api.bridgemoni.com/reconciliation/run/b3f1c2d4-5e6a-4b7c-8d9e-0f1a2b3c4d5e/charge" \
  -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",
    "certificateReference": "b3f1c2d4-5e6a-4b7c-8d9e-0f1a2b3c4d5e",
    "definitionCode": "string",
    "chargeBearer": "string",
    "bearerEntityCode": "string",
    "billingAccountNumber": "string",
    "billableRecords": 0,
    "bandLabel": "string",
    "amount": "string",
    "currencyCode": "string",
    "status": "string",
    "withheld": true,
    "shortfall": "string",
    "settlementReference": "b3f1c2d4-5e6a-4b7c-8d9e-0f1a2b3c4d5e",
    "raisedAt": "string",
    "settledAt": "string",
    "attempts": 0,
    "failureReason": "string"
  },
  "description": "Charge retrieved successfully"
}

Responses

Status	When
`200`	Charge retrieved successfully

POST Settle a withheld charge after funding the account

POST /reconciliation/run/{reference}/charge/settle

Retries the debit against the entity's prepaid account. Bridge never refuses ingestion for non-payment - refusing would lose the very data the customer is paying to have reconciled - so the records were accepted and the comparison ran. What was withheld is the output, and settling releases it immediately with nothing to re-run.

Headers

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

Path parameters

Name
`reference`

Example

Response: GenericResponseChargeResponse

curl -X POST "https://api.bridgemoni.com/reconciliation/run/b3f1c2d4-5e6a-4b7c-8d9e-0f1a2b3c4d5e/charge/settle" \
  -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",
    "certificateReference": "b3f1c2d4-5e6a-4b7c-8d9e-0f1a2b3c4d5e",
    "definitionCode": "string",
    "chargeBearer": "string",
    "bearerEntityCode": "string",
    "billingAccountNumber": "string",
    "billableRecords": 0,
    "bandLabel": "string",
    "amount": "string",
    "currencyCode": "string",
    "status": "string",
    "withheld": true,
    "shortfall": "string",
    "settlementReference": "b3f1c2d4-5e6a-4b7c-8d9e-0f1a2b3c4d5e",
    "raisedAt": "string",
    "settledAt": "string",
    "attempts": 0,
    "failureReason": "string"
  },
  "description": "Charge settled successfully"
}

Responses

Status	When
`200`	Charge settled successfully

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