API reference · Platform & integration

Open Banking Confirmation of Funds API

POST/openbanking/{tenantId}/v3.1/cbpii/funds-confirmation-consentsCreate a funds confirmation consent
DELETE/openbanking/{tenantId}/v3.1/cbpii/funds-confirmation-consents/{consentId}Revoke a funds confirmation consent
GET/openbanking/{tenantId}/v3.1/cbpii/funds-confirmation-consents/{consentId}Read a funds confirmation consent
POST/openbanking/{tenantId}/v3.1/cbpii/funds-confirmationsAsk whether an amount is available

POST Create a funds confirmation consent

POST /openbanking/{tenantId}/v3.1/cbpii/funds-confirmation-consents

Client-credentials token with scope fundsconfirmations. Names one DebtorAccount; lasts until ExpirationDateTime, at most a year, a year when absent.

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: ObResponseFundsConfirmationConsentData

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

"string"

{
  "Data": {
    "ConsentId": "string",
    "CreationDateTime": "string",
    "Status": "string",
    "StatusUpdateDateTime": "string",
    "ExpirationDateTime": "string",
    "DebtorAccount": {
      "SchemeName": "string",
      "Identification": "string",
      "Name": "string",
      "SecondaryIdentification": "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 Revoke a funds confirmation consent

DELETE /openbanking/{tenantId}/v3.1/cbpii/funds-confirmation-consents/{consentId}

Revokes it and every token issued under it.

Headers

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

Path parameters

Name
`tenantId`
`consentId`

Example

curl -X DELETE "https://api.bridgemoni.com/openbanking/b3f1c2d4-5e6a-4b7c-8d9e-0f1a2b3c4d5e/v3.1/cbpii/funds-confirmation-consents/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

GET Read a funds confirmation consent

GET /openbanking/{tenantId}/v3.1/cbpii/funds-confirmation-consents/{consentId}

Headers

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

Path parameters

Name
`tenantId`
`consentId`

Example

Response: ObResponseFundsConfirmationConsentData

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

{
  "Data": {
    "ConsentId": "string",
    "CreationDateTime": "string",
    "Status": "string",
    "StatusUpdateDateTime": "string",
    "ExpirationDateTime": "string",
    "DebtorAccount": {
      "SchemeName": "string",
      "Identification": "string",
      "Name": "string",
      "SecondaryIdentification": "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 Ask whether an amount is available

POST /openbanking/{tenantId}/v3.1/cbpii/funds-confirmations

Authorization-code token for the authorised consent. Answers FundsAvailable true or false and never a balance. Limited per consent, because a yes/no oracle can be searched into the balance.

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: ObResponseFundsConfirmationResultData

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

"string"

{
  "Data": {
    "FundsConfirmationId": "string",
    "ConsentId": "string",
    "CreationDateTime": "string",
    "FundsAvailable": true,
    "Reference": "b3f1c2d4-5e6a-4b7c-8d9e-0f1a2b3c4d5e",
    "InstructedAmount": {
      "Amount": "string",
      "Currency": "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