API reference · Pricing, reporting & reconciliation

Reconciliation quarantine

GET/reconciliation/entity/{code}/quarantineList deliveries that did not verify
GET/reconciliation/quarantineList every quarantined delivery still awaiting a decision

GET List deliveries that did not verify

GET /reconciliation/entity/{code}/quarantine

Everything held for this entity, newest first, with the named reason each was held for. A run of UNKNOWN_KEY entries usually means a counterparty rotated a key without telling anybody; a run of SIGNATURE_INVALID from one address usually does not.

Headers

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

Path parameters

Name
`code`

Example

Response: GenericResponseListQuarantineResponse

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

{
  "data": [
    {
      "reference": "b3f1c2d4-5e6a-4b7c-8d9e-0f1a2b3c4d5e",
      "entityCode": "string",
      "channelKey": "string",
      "receivedAt": "string",
      "transport": "string",
      "documentReference": "b3f1c2d4-5e6a-4b7c-8d9e-0f1a2b3c4d5e",
      "originalFilename": "string",
      "sizeBytes": 0,
      "contentHash": "string",
      "declaredKeyId": "string",
      "failureKind": "string",
      "failureDetail": "string",
      "remoteAddress": "string",
      "releasedAt": "string",
      "releasedBy": "string",
      "releaseReason": "string"
    }
  ],
  "description": "Quarantined deliveries retrieved successfully"
}

Responses

Status	When
`200`	Quarantined deliveries retrieved successfully

GET List every quarantined delivery still awaiting a decision

GET /reconciliation/quarantine

The operations queue. A delivery sits here until somebody decides what it was - which is the point: nothing releases itself, and nothing is parsed while it waits.

Headers

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

Example

Response: GenericResponseListQuarantineResponse

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

{
  "data": [
    {
      "reference": "b3f1c2d4-5e6a-4b7c-8d9e-0f1a2b3c4d5e",
      "entityCode": "string",
      "channelKey": "string",
      "receivedAt": "string",
      "transport": "string",
      "documentReference": "b3f1c2d4-5e6a-4b7c-8d9e-0f1a2b3c4d5e",
      "originalFilename": "string",
      "sizeBytes": 0,
      "contentHash": "string",
      "declaredKeyId": "string",
      "failureKind": "string",
      "failureDetail": "string",
      "remoteAddress": "string",
      "releasedAt": "string",
      "releasedBy": "string",
      "releaseReason": "string"
    }
  ],
  "description": "Quarantined deliveries retrieved successfully"
}

Responses

Status	When
`200`	Quarantined deliveries retrieved successfully

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