API reference · Platform & integration

Open Banking Event Notification API

GET/openbanking/{tenantId}/v3.1/callback-urlsThe client's callback URL
POST/openbanking/{tenantId}/v3.1/callback-urlsRegister a callback URL
DELETE/openbanking/{tenantId}/v3.1/callback-urls/{callbackUrlId}Delete the callback URL
PUT/openbanking/{tenantId}/v3.1/callback-urls/{callbackUrlId}Change the callback URL
GET/openbanking/{tenantId}/v3.1/event-subscriptionsThe client's event subscription
POST/openbanking/{tenantId}/v3.1/event-subscriptionsSubscribe to events
DELETE/openbanking/{tenantId}/v3.1/event-subscriptions/{subscriptionId}Delete the event subscription
PUT/openbanking/{tenantId}/v3.1/event-subscriptions/{subscriptionId}Change the event subscription
POST/openbanking/{tenantId}/v3.1/eventsPoll for events, acknowledging those already handled

GET The client's callback URL

GET /openbanking/{tenantId}/v3.1/callback-urls

Headers

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

Path parameters

Name
`tenantId`

Example

Response: ObResponseCallbackUrlsData

curl -X GET "https://api.bridgemoni.com/openbanking/b3f1c2d4-5e6a-4b7c-8d9e-0f1a2b3c4d5e/v3.1/callback-urls" \
  -H "Authorization: Bearer $BRIDGEMONI_TOKEN" \
  -H "X-Tenant: $BRIDGEMONI_TENANT" \
  -H "X-Environment: $BRIDGEMONI_ENV"

{
  "Data": {
    "CallbackUrl": [
      {
        "CallbackUrlId": "string",
        "Url": "string",
        "Version": "string"
      }
    ]
  },
  "Risk": {},
  "Links": {
    "Self": "string",
    "First": "string",
    "Prev": "string",
    "Next": "string",
    "Last": "string"
  },
  "Meta": {
    "TotalPages": 0,
    "FirstAvailableDateTime": "string",
    "LastAvailableDateTime": "string"
  }
}

Responses

Status	When
`200`	OK

POST Register a callback URL

POST /openbanking/{tenantId}/v3.1/callback-urls

The legacy form of a subscription with a CallbackUrl: one callback per client, and the CallbackUrlId is the client's event subscription id. Without a subscription, one is created for every supported event type; with one that has no callback, the callback is added to it. Events are pushed as signed Security Event Tokens to {Url}/event-notifications and stay pollable until acknowledged.

Headers

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

Path parameters

Name
`tenantId`

Example

Request body: string · Response: ObResponseCallbackUrlData

curl -X POST "https://api.bridgemoni.com/openbanking/b3f1c2d4-5e6a-4b7c-8d9e-0f1a2b3c4d5e/v3.1/callback-urls" \
  -H "Authorization: Bearer $BRIDGEMONI_TOKEN" \
  -H "X-Tenant: $BRIDGEMONI_TENANT" \
  -H "X-Environment: $BRIDGEMONI_ENV" \
  -H "Content-Type: application/json" \
  -d '"string"'

"string"

{
  "Data": {
    "CallbackUrlId": "string",
    "Url": "string",
    "Version": "string"
  },
  "Risk": {},
  "Links": {
    "Self": "string",
    "First": "string",
    "Prev": "string",
    "Next": "string",
    "Last": "string"
  },
  "Meta": {
    "TotalPages": 0,
    "FirstAvailableDateTime": "string",
    "LastAvailableDateTime": "string"
  }
}

Responses

Status	When
`200`	OK

DELETE Delete the callback URL

DELETE /openbanking/{tenantId}/v3.1/callback-urls/{callbackUrlId}

Stops push delivery. The subscription and its undelivered events remain pollable.

Headers

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

Path parameters

Name
`tenantId`
`callbackUrlId`

Example

curl -X DELETE "https://api.bridgemoni.com/openbanking/b3f1c2d4-5e6a-4b7c-8d9e-0f1a2b3c4d5e/v3.1/callback-urls/b3f1c2d4-5e6a-4b7c-8d9e-0f1a2b3c4d5e" \
  -H "Authorization: Bearer $BRIDGEMONI_TOKEN" \
  -H "X-Tenant: $BRIDGEMONI_TENANT" \
  -H "X-Environment: $BRIDGEMONI_ENV"

Responses

Status	When
`200`	OK

PUT Change the callback URL

PUT /openbanking/{tenantId}/v3.1/callback-urls/{callbackUrlId}

Headers

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

Path parameters

Name
`tenantId`
`callbackUrlId`

Example

Request body: string · Response: ObResponseCallbackUrlData

curl -X PUT "https://api.bridgemoni.com/openbanking/b3f1c2d4-5e6a-4b7c-8d9e-0f1a2b3c4d5e/v3.1/callback-urls/b3f1c2d4-5e6a-4b7c-8d9e-0f1a2b3c4d5e" \
  -H "Authorization: Bearer $BRIDGEMONI_TOKEN" \
  -H "X-Tenant: $BRIDGEMONI_TENANT" \
  -H "X-Environment: $BRIDGEMONI_ENV" \
  -H "Content-Type: application/json" \
  -d '"string"'

"string"

{
  "Data": {
    "CallbackUrlId": "string",
    "Url": "string",
    "Version": "string"
  },
  "Risk": {},
  "Links": {
    "Self": "string",
    "First": "string",
    "Prev": "string",
    "Next": "string",
    "Last": "string"
  },
  "Meta": {
    "TotalPages": 0,
    "FirstAvailableDateTime": "string",
    "LastAvailableDateTime": "string"
  }
}

Responses

Status	When
`200`	OK

GET The client's event subscription

GET /openbanking/{tenantId}/v3.1/event-subscriptions

Headers

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

Path parameters

Name
`tenantId`

Example

Response: ObResponseEventSubscriptionsData

curl -X GET "https://api.bridgemoni.com/openbanking/b3f1c2d4-5e6a-4b7c-8d9e-0f1a2b3c4d5e/v3.1/event-subscriptions" \
  -H "Authorization: Bearer $BRIDGEMONI_TOKEN" \
  -H "X-Tenant: $BRIDGEMONI_TENANT" \
  -H "X-Environment: $BRIDGEMONI_ENV"

{
  "Data": {
    "EventSubscription": [
      {
        "EventSubscriptionId": "string",
        "CallbackUrl": "string",
        "Version": "string",
        "EventTypes": [
          "string"
        ]
      }
    ]
  },
  "Risk": {},
  "Links": {
    "Self": "string",
    "First": "string",
    "Prev": "string",
    "Next": "string",
    "Last": "string"
  },
  "Meta": {
    "TotalPages": 0,
    "FirstAvailableDateTime": "string",
    "LastAvailableDateTime": "string"
  }
}

Responses

Status	When
`200`	OK

POST Subscribe to events

POST /openbanking/{tenantId}/v3.1/event-subscriptions

One subscription per client. With a CallbackUrl, each event is also pushed as a signed Security Event Token to {CallbackUrl}/event-notifications; every event is available by polling until acknowledged. Events carry a resource reference and a link, never data.

Headers

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

Path parameters

Name
`tenantId`

Example

Request body: string · Response: ObResponseEventSubscriptionData

curl -X POST "https://api.bridgemoni.com/openbanking/b3f1c2d4-5e6a-4b7c-8d9e-0f1a2b3c4d5e/v3.1/event-subscriptions" \
  -H "Authorization: Bearer $BRIDGEMONI_TOKEN" \
  -H "X-Tenant: $BRIDGEMONI_TENANT" \
  -H "X-Environment: $BRIDGEMONI_ENV" \
  -H "Content-Type: application/json" \
  -d '"string"'

"string"

{
  "Data": {
    "EventSubscriptionId": "string",
    "CallbackUrl": "string",
    "Version": "string",
    "EventTypes": [
      "string"
    ]
  },
  "Risk": {},
  "Links": {
    "Self": "string",
    "First": "string",
    "Prev": "string",
    "Next": "string",
    "Last": "string"
  },
  "Meta": {
    "TotalPages": 0,
    "FirstAvailableDateTime": "string",
    "LastAvailableDateTime": "string"
  }
}

Responses

Status	When
`200`	OK

DELETE Delete the event subscription

DELETE /openbanking/{tenantId}/v3.1/event-subscriptions/{subscriptionId}

Headers

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

Path parameters

Name
`tenantId`
`subscriptionId`

Example

curl -X DELETE "https://api.bridgemoni.com/openbanking/b3f1c2d4-5e6a-4b7c-8d9e-0f1a2b3c4d5e/v3.1/event-subscriptions/b3f1c2d4-5e6a-4b7c-8d9e-0f1a2b3c4d5e" \
  -H "Authorization: Bearer $BRIDGEMONI_TOKEN" \
  -H "X-Tenant: $BRIDGEMONI_TENANT" \
  -H "X-Environment: $BRIDGEMONI_ENV"

Responses

Status	When
`200`	OK

PUT Change the event subscription

PUT /openbanking/{tenantId}/v3.1/event-subscriptions/{subscriptionId}

Headers

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

Path parameters

Name
`tenantId`
`subscriptionId`

Example

Request body: string · Response: ObResponseEventSubscriptionData

curl -X PUT "https://api.bridgemoni.com/openbanking/b3f1c2d4-5e6a-4b7c-8d9e-0f1a2b3c4d5e/v3.1/event-subscriptions/b3f1c2d4-5e6a-4b7c-8d9e-0f1a2b3c4d5e" \
  -H "Authorization: Bearer $BRIDGEMONI_TOKEN" \
  -H "X-Tenant: $BRIDGEMONI_TENANT" \
  -H "X-Environment: $BRIDGEMONI_ENV" \
  -H "Content-Type: application/json" \
  -d '"string"'

"string"

{
  "Data": {
    "EventSubscriptionId": "string",
    "CallbackUrl": "string",
    "Version": "string",
    "EventTypes": [
      "string"
    ]
  },
  "Risk": {},
  "Links": {
    "Self": "string",
    "First": "string",
    "Prev": "string",
    "Next": "string",
    "Last": "string"
  },
  "Meta": {
    "TotalPages": 0,
    "FirstAvailableDateTime": "string",
    "LastAvailableDateTime": "string"
  }
}

Responses

Status	When
`200`	OK

POST Poll for events, acknowledging those already handled

POST /openbanking/{tenantId}/v3.1/events

Aggregated polling (RFC 8936 shape). Acknowledgement removes an event from the poll, never from the record.

Headers

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

Path parameters

Name
`tenantId`

Example

Request body: string · Response: EventPollResponse

curl -X POST "https://api.bridgemoni.com/openbanking/b3f1c2d4-5e6a-4b7c-8d9e-0f1a2b3c4d5e/v3.1/events" \
  -H "Authorization: Bearer $BRIDGEMONI_TOKEN" \
  -H "X-Tenant: $BRIDGEMONI_TENANT" \
  -H "X-Environment: $BRIDGEMONI_ENV" \
  -H "Content-Type: application/json" \
  -d '"string"'

"string"

{
  "sets": {},
  "moreAvailable": true
}

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