API reference · Platform & integration

Open Banking Open Data

GET/openbanking/{tenantId}/v3.1/open-data/agentsThe tenant's cash agents
GET/openbanking/{tenantId}/v3.1/open-data/atmsThe tenant's ATMs
GET/openbanking/{tenantId}/v3.1/open-data/branchesThe tenant's branches
GET/openbanking/{tenantId}/v3.1/open-data/feesPublished fees
GET/openbanking/{tenantId}/v3.1/open-data/productsThe tenant's published account products
GET/openbanking/{tenantId}/v3.1/open-data/ratesExchange rates and product interest rates

GET The tenant's cash agents

GET /openbanking/{tenantId}/v3.1/open-data/agents

Nigeria-specific: the agent network.

Headers

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

Path parameters

Name
`tenantId`

Example

Response: ObResponseObServicePointData

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

{
  "Data": {
    "ServicePoint": [
      {
        "Identification": "string",
        "Name": "string",
        "Type": "string",
        "PostalAddress": {
          "StreetName": "string",
          "BuildingNumber": "string",
          "TownName": "string",
          "CountrySubDivision": "string",
          "PostCode": "string",
          "Country": "string",
          "GeoLocation": {
            "Latitude": "string",
            "Longitude": "string"
          }
        },
        "OpeningHours": "string",
        "Services": [
          "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 tenant's ATMs

GET /openbanking/{tenantId}/v3.1/open-data/atms

Headers

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

Path parameters

Name
`tenantId`

Example

Response: ObResponseObServicePointData

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

{
  "Data": {
    "ServicePoint": [
      {
        "Identification": "string",
        "Name": "string",
        "Type": "string",
        "PostalAddress": {
          "StreetName": "string",
          "BuildingNumber": "string",
          "TownName": "string",
          "CountrySubDivision": "string",
          "PostCode": "string",
          "Country": "string",
          "GeoLocation": {
            "Latitude": "string",
            "Longitude": "string"
          }
        },
        "OpeningHours": "string",
        "Services": [
          "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 tenant's branches

GET /openbanking/{tenantId}/v3.1/open-data/branches

Headers

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

Path parameters

Name
`tenantId`

Example

Response: ObResponseObServicePointData

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

{
  "Data": {
    "ServicePoint": [
      {
        "Identification": "string",
        "Name": "string",
        "Type": "string",
        "PostalAddress": {
          "StreetName": "string",
          "BuildingNumber": "string",
          "TownName": "string",
          "CountrySubDivision": "string",
          "PostCode": "string",
          "Country": "string",
          "GeoLocation": {
            "Latitude": "string",
            "Longitude": "string"
          }
        },
        "OpeningHours": "string",
        "Services": [
          "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 Published fees

GET /openbanking/{tenantId}/v3.1/open-data/fees

Active pricing rules whose conditions can be stated publicly. A rule priced by formula, by cumulative spend, by time or date, or by a free expression is not published, because such a rule can single out one customer and no public table can state it truthfully.

Headers

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

Path parameters

Name
`tenantId`

Example

Response: ObResponseObFeeData

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

{
  "Data": {
    "Fee": [
      {
        "Name": "string",
        "Category": "string",
        "CalculationMethod": "string",
        "Currency": "string",
        "FixedAmount": "string",
        "PercentageRate": "string",
        "MinimumCharge": "string",
        "MaximumCharge": "string",
        "Tiers": [
          {
            "FromAmount": "string",
            "ToAmount": "string",
            "Rate": "string",
            "FixedAmount": "string"
          }
        ],
        "AppliesWhen": [
          {
            "TransactionTypes": [
              "string"
            ],
            "Direction": "string",
            "Channel": "string",
            "KycTierScheme": "string",
            "MinimumTierLevel": "string",
            "MaximumTierLevel": "string",
            "MinimumTransactionAmount": "string",
            "MaximumTransactionAmount": "string"
          }
        ],
        "EffectiveFrom": "string",
        "EffectiveTo": "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 tenant's published account products

GET /openbanking/{tenantId}/v3.1/open-data/products

No token, no consent, no customer: public catalogue data, the same for every caller, and cacheable for five minutes. Rate-limited per caller address.

Headers

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

Path parameters

Name
`tenantId`

Example

Response: ObResponseObOpenProductData

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

{
  "Data": {
    "Product": [
      {
        "ProductId": "string",
        "ProductName": "string",
        "ProductType": "string",
        "Currency": "string",
        "Description": "string",
        "AnnualInterestRate": "string",
        "MinimumOpeningBalance": {
          "Amount": "string",
          "Currency": "string"
        },
        "MonthlyMaintenanceFee": {
          "Amount": "string",
          "Currency": "string"
        },
        "Eligibility": "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 Exchange rates and product interest rates

GET /openbanking/{tenantId}/v3.1/open-data/rates

Board rates before any customer spread, and each live product's annual interest rate.

Headers

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

Path parameters

Name
`tenantId`

Example

Response: ObResponseObRateData

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

{
  "Data": {
    "Rate": [
      {
        "RateType": "string",
        "ProductId": "string",
        "SourceCurrency": "string",
        "TargetCurrency": "string",
        "BuyRate": "string",
        "SellRate": "string",
        "Rate": "string",
        "EffectiveDateTime": "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

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