API reference · Platform & integration

ISO 20022 catalogue

GET/iso20022/catalogueSummarise the ISO 20022 catalogue
GET/iso20022/catalogue/definition/{identifier}Read one catalogue message definition
GET/iso20022/catalogue/definitionsList catalogue message definitions
GET/iso20022/profile/{code}Read one market-practice profile
GET/iso20022/profilesList market-practice profiles

GET Summarise the ISO 20022 catalogue

GET /iso20022/catalogue

Every message definition version Bridge can receive and validate, how many it acts on, and how many it archives and refuses with admi.002.

Headers

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

Example

Response: GenericResponseIsoCatalogueSummaryResponse

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

{
  "data": {
    "release": "string",
    "definitionCount": 0,
    "versionCount": 0,
    "handledCount": 0,
    "refusedCount": 0,
    "versionsByArea": {},
    "withoutDisposition": 0
  },
  "description": "OK"
}

Responses

Status	When
`200`	OK

GET Read one catalogue message definition

GET /iso20022/catalogue/definition/{identifier}

Headers

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

Path parameters

Name
`identifier`

Example

Response: GenericResponseIsoCatalogueDefinitionResponse

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

{
  "data": {
    "identifier": "pacs.008.001.08",
    "businessArea": "pacs",
    "businessAreaName": "Payments Clearing and Settlement",
    "messageName": "FIToFICustomerCreditTransfer",
    "rootElement": "FIToFICstmrCdtTrf",
    "disposition": "HANDLED",
    "owner": "payments/cards",
    "dispositionReason": "string",
    "versions": [
      "string"
    ],
    "xsdDigest": "string"
  },
  "description": "OK"
}

Responses

Status	When
`200`	OK

GET List catalogue message definitions

GET /iso20022/catalogue/definitions

Headers

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

Query parameters

Name	Default
`businessArea`	Optional
`disposition`	Optional
`page`	0
`size`	50

Example

Response: GenericResponsePagerIsoCatalogueDefinitionResponse

curl -X GET "https://api.bridgemoni.com/iso20022/catalogue/definitions?page=value&size=50" \
  -H "Authorization: Bearer $BRIDGEMONI_TOKEN" \
  -H "X-Tenant: $BRIDGEMONI_TENANT" \
  -H "X-Environment: $BRIDGEMONI_ENV"

{
  "data": {
    "content": [
      {
        "identifier": "pacs.008.001.08",
        "businessArea": "pacs",
        "businessAreaName": "Payments Clearing and Settlement",
        "messageName": "FIToFICustomerCreditTransfer",
        "rootElement": "FIToFICstmrCdtTrf",
        "disposition": "HANDLED",
        "owner": "payments/cards",
        "dispositionReason": "string",
        "versions": [
          "string"
        ],
        "xsdDigest": "string"
      }
    ],
    "page": "1",
    "size": "1",
    "totalPages": "1",
    "totalElements": "1"
  },
  "description": "OK"
}

Responses

Status	When
`200`	OK

GET Read one market-practice profile

GET /iso20022/profile/{code}

Headers

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

Path parameters

Name
`code`

Example

Response: GenericResponseIsoProfileResponse

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

{
  "data": {
    "code": "CBPR_PLUS",
    "release": "SR2025",
    "description": "string",
    "characterSet": "SWIFT_X",
    "addressPolicy": "HYBRID",
    "settlementModel": "PRE_SETTLEMENT_ANSWER",
    "definitions": [
      "string"
    ],
    "ruleCount": 0
  },
  "description": "OK"
}

Responses

Status	When
`200`	OK

GET List market-practice profiles

GET /iso20022/profiles

Headers

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

Example

Response: GenericResponseListIsoProfileResponse

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

{
  "data": [
    {
      "code": "CBPR_PLUS",
      "release": "SR2025",
      "description": "string",
      "characterSet": "SWIFT_X",
      "addressPolicy": "HYBRID",
      "settlementModel": "PRE_SETTLEMENT_ANSWER",
      "definitions": [
        "string"
      ],
      "ruleCount": 0
    }
  ],
  "description": "OK"
}

Responses

Status	When
`200`	OK

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