API reference · Platform & integration

Open Banking Customer Consents

GET/openbanking/{tenantId}/consentsThe services I have given access to my accounts
DELETE/openbanking/{tenantId}/consents/{consentId}Withdraw a service's access to my accounts
GET/openbanking/{tenantId}/consents/{consentId}/paymentsEvery payment made under one of my consents

GET The services I have given access to my accounts

GET /openbanking/{tenantId}/consents

Headers

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

Path parameters

Name
`tenantId`

Example

Response: GenericResponseListCustomerConsentResponse

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

{
  "data": [
    {
      "consentId": "string",
      "consentType": "string",
      "clientName": "string",
      "participantName": "string",
      "status": "string",
      "permissions": [
        "string"
      ],
      "accountCount": 0,
      "authorisedDateTime": "2026-09-25T10:00:00Z",
      "expirationDateTime": "2026-09-25T10:00:00Z"
    }
  ],
  "description": "OK"
}

Responses

Status	When
`200`	OK

DELETE Withdraw a service's access to my accounts

DELETE /openbanking/{tenantId}/consents/{consentId}

Revokes the consent and every token issued under it, immediately.

Headers

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

Path parameters

Name
`tenantId`
`consentId`

Example

Response: GenericResponseVoid

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

{
  "data": "string",
  "description": "OK"
}

Responses

Status	When
`200`	OK

GET Every payment made under one of my consents

GET /openbanking/{tenantId}/consents/{consentId}/payments

For a payment or variable recurring payment consent: every payment taken, refused or pending under it, from the same rows the limits are checked against.

Headers

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

Path parameters

Name
`tenantId`
`consentId`

Example

Response: GenericResponseListCustomerConsentPaymentResponse

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

{
  "data": [
    {
      "paymentId": "string",
      "paymentType": "string",
      "amount": 0,
      "currencyCode": "string",
      "status": "string",
      "statusReason": "string",
      "creationDateTime": "2026-09-25T10:00:00Z",
      "statusUpdateDateTime": "2026-09-25T10:00:00Z"
    }
  ],
  "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