API reference · Platform & integration

Open Banking Account and Transaction API

Serve your accounts to third parties with consent. About open banking Next

POST/openbanking/{tenantId}/v3.1/aisp/account-access-consentsCreate an account access consent
DELETE/openbanking/{tenantId}/v3.1/aisp/account-access-consents/{consentId}Delete an account access consent
GET/openbanking/{tenantId}/v3.1/aisp/account-access-consents/{consentId}Read an account access consent
GET/openbanking/{tenantId}/v3.1/aisp/accountsThe accounts the consent covers
GET/openbanking/{tenantId}/v3.1/aisp/accounts/{accountId}One account the consent covers
GET/openbanking/{tenantId}/v3.1/aisp/accounts/{accountId}/balancesBalances of one account
GET/openbanking/{tenantId}/v3.1/aisp/accounts/{accountId}/beneficiariesBeneficiaries of one account
GET/openbanking/{tenantId}/v3.1/aisp/accounts/{accountId}/direct-debitsDirectDebits of one account
GET/openbanking/{tenantId}/v3.1/aisp/accounts/{accountId}/offersOffers of one account
GET/openbanking/{tenantId}/v3.1/aisp/accounts/{accountId}/partiesEvery party on one account
GET/openbanking/{tenantId}/v3.1/aisp/accounts/{accountId}/partyThe party that holds one account
GET/openbanking/{tenantId}/v3.1/aisp/accounts/{accountId}/productProducts of one account
GET/openbanking/{tenantId}/v3.1/aisp/accounts/{accountId}/scheduled-paymentsScheduledPayments of one account
GET/openbanking/{tenantId}/v3.1/aisp/accounts/{accountId}/standing-ordersStandingOrders of one account
GET/openbanking/{tenantId}/v3.1/aisp/accounts/{accountId}/statementsMonthly statements of one account
GET/openbanking/{tenantId}/v3.1/aisp/accounts/{accountId}/statements/{statementId}One statement
GET/openbanking/{tenantId}/v3.1/aisp/accounts/{accountId}/statements/{statementId}/fileThe statement file
GET/openbanking/{tenantId}/v3.1/aisp/accounts/{accountId}/statements/{statementId}/transactionsThe transactions on one statement
GET/openbanking/{tenantId}/v3.1/aisp/accounts/{accountId}/transactionsTransactions of one account
GET/openbanking/{tenantId}/v3.1/aisp/balancesBalances of every account the consent covers
GET/openbanking/{tenantId}/v3.1/aisp/beneficiariesBeneficiaries
GET/openbanking/{tenantId}/v3.1/aisp/direct-debitsDirectDebits
GET/openbanking/{tenantId}/v3.1/aisp/offersOffers
GET/openbanking/{tenantId}/v3.1/aisp/partyThe customer who authorised the consent
GET/openbanking/{tenantId}/v3.1/aisp/productsProducts
GET/openbanking/{tenantId}/v3.1/aisp/scheduled-paymentsScheduledPayments
GET/openbanking/{tenantId}/v3.1/aisp/standing-ordersStandingOrders
GET/openbanking/{tenantId}/v3.1/aisp/statementsMonthly statements of every account the consent covers
GET/openbanking/{tenantId}/v3.1/aisp/transactionsTransactions of every account the consent covers

POST Create an account access consent

POST /openbanking/{tenantId}/v3.1/aisp/account-access-consents

Client-credentials token with scope accounts. Permissions: ReadAccountsBasic, ReadAccountsDetail, ReadBalances, ReadTransactionsBasic, ReadTransactionsDetail, ReadTransactionsCredits, ReadTransactionsDebits; transaction detail needs at least one direction and a direction needs a transaction permission. ExpirationDateTime at most 90 days ahead, 90 days when absent. The ConsentId is the openbanking_intent_id for the pushed authorization request.

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

curl -X POST "https://api.bridgemoni.com/openbanking/b3f1c2d4-5e6a-4b7c-8d9e-0f1a2b3c4d5e/v3.1/aisp/account-access-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",
    "Status": "string",
    "StatusUpdateDateTime": "string",
    "CreationDateTime": "string",
    "Permissions": [
      "string"
    ],
    "ExpirationDateTime": "string",
    "TransactionFromDateTime": "string",
    "TransactionToDateTime": "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 an account access consent

DELETE /openbanking/{tenantId}/v3.1/aisp/account-access-consents/{consentId}

Revokes the consent and, in the same transaction, 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/aisp/account-access-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 an account access consent

GET /openbanking/{tenantId}/v3.1/aisp/account-access-consents/{consentId}

Headers

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

Path parameters

Name
`tenantId`
`consentId`

Example

Response: ObResponseAccountAccessConsentData

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

{
  "Data": {
    "ConsentId": "string",
    "Status": "string",
    "StatusUpdateDateTime": "string",
    "CreationDateTime": "string",
    "Permissions": [
      "string"
    ],
    "ExpirationDateTime": "string",
    "TransactionFromDateTime": "string",
    "TransactionToDateTime": "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 accounts the consent covers

GET /openbanking/{tenantId}/v3.1/aisp/accounts

Headers

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

Path parameters

Name
`tenantId`

Example

Response: ObResponseObAccountData

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

{
  "Data": {
    "Account": [
      {
        "AccountId": "string",
        "Status": "string",
        "StatusUpdateDateTime": "string",
        "Currency": "string",
        "AccountType": "string",
        "AccountSubType": "string",
        "Nickname": "string",
        "Account": [
          {
            "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

GET One account the consent covers

GET /openbanking/{tenantId}/v3.1/aisp/accounts/{accountId}

Headers

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

Path parameters

Name
`tenantId`
`accountId`

Example

Response: ObResponseObAccountData

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

{
  "Data": {
    "Account": [
      {
        "AccountId": "string",
        "Status": "string",
        "StatusUpdateDateTime": "string",
        "Currency": "string",
        "AccountType": "string",
        "AccountSubType": "string",
        "Nickname": "string",
        "Account": [
          {
            "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

GET Balances of one account

GET /openbanking/{tenantId}/v3.1/aisp/accounts/{accountId}/balances

Headers

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

Path parameters

Name
`tenantId`
`accountId`

Example

Response: ObResponseObBalanceData

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

{
  "Data": {
    "Balance": [
      {
        "AccountId": "string",
        "Amount": {
          "Amount": "string",
          "Currency": "string"
        },
        "CreditDebitIndicator": "string",
        "Type": "string",
        "DateTime": "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 Beneficiaries of one account

GET /openbanking/{tenantId}/v3.1/aisp/accounts/{accountId}/beneficiaries

Saved payees. Bridge saves payees per customer, not per account, so the account-scoped form returns the same payees for any account the consent covers.

Headers

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

Path parameters

Name
`tenantId`
`accountId`

Example

Response: ObResponseObBeneficiaryData

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

{
  "Data": {
    "Beneficiary": [
      {
        "BeneficiaryId": "string",
        "BeneficiaryType": "string",
        "Reference": "b3f1c2d4-5e6a-4b7c-8d9e-0f1a2b3c4d5e",
        "CreditorAgent": {
          "SchemeName": "string",
          "Identification": "string",
          "Name": "string"
        },
        "CreditorAccount": {
          "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

GET DirectDebits of one account

GET /openbanking/{tenantId}/v3.1/aisp/accounts/{accountId}/direct-debits

Always an empty collection today: Bridge accounts carry no direct-debit mandates.

Headers

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

Path parameters

Name
`tenantId`
`accountId`

Example

Response: ObResponseObDirectDebitData

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

{
  "Data": {
    "DirectDebit": [
      "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 Offers of one account

GET /openbanking/{tenantId}/v3.1/aisp/accounts/{accountId}/offers

Always an empty collection: Bridge has no offers.

Headers

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

Path parameters

Name
`tenantId`
`accountId`

Example

Response: ObResponseObOfferData

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

{
  "Data": {
    "Offer": [
      "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 Every party on one account

GET /openbanking/{tenantId}/v3.1/aisp/accounts/{accountId}/parties

ReadParty. Bridge accounts have exactly one holder, so this is a list of one.

Headers

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

Path parameters

Name
`tenantId`
`accountId`

Example

Response: ObResponseObPartiesData

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

{
  "Data": {
    "Party": [
      {
        "PartyId": "string",
        "PartyType": "string",
        "Name": "string",
        "EmailAddress": "ada@example.com",
        "Mobile": "string",
        "Address": [
          {
            "AddressType": "string",
            "StreetName": "string",
            "BuildingNumber": "string",
            "PostCode": "string",
            "TownName": "string",
            "CountrySubDivision": "string",
            "Country": "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 party that holds one account

GET /openbanking/{tenantId}/v3.1/aisp/accounts/{accountId}/party

ReadParty. The same six-field allow-list.

Headers

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

Path parameters

Name
`tenantId`
`accountId`

Example

Response: ObResponseObPartyData

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

{
  "Data": {
    "Party": {
      "PartyId": "string",
      "PartyType": "string",
      "Name": "string",
      "EmailAddress": "ada@example.com",
      "Mobile": "string",
      "Address": [
        {
          "AddressType": "string",
          "StreetName": "string",
          "BuildingNumber": "string",
          "PostCode": "string",
          "TownName": "string",
          "CountrySubDivision": "string",
          "Country": "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 Products of one account

GET /openbanking/{tenantId}/v3.1/aisp/accounts/{accountId}/product

The live catalogue product for each consented account, matched on account type and currency. An account whose type has no published product is simply absent.

Headers

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

Path parameters

Name
`tenantId`
`accountId`

Example

Response: ObResponseObProductData

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

{
  "Data": {
    "Product": [
      "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 ScheduledPayments of one account

GET /openbanking/{tenantId}/v3.1/aisp/accounts/{accountId}/scheduled-payments

One-off future-dated transfers drawn on the consented accounts.

Headers

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

Path parameters

Name
`tenantId`
`accountId`

Example

Response: ObResponseObScheduledPaymentData

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

{
  "Data": {
    "ScheduledPayment": [
      {
        "AccountId": "string",
        "ScheduledPaymentId": "string",
        "ScheduledPaymentDateTime": "string",
        "ScheduledType": "string",
        "Reference": "b3f1c2d4-5e6a-4b7c-8d9e-0f1a2b3c4d5e",
        "InstructedAmount": {
          "Amount": "string",
          "Currency": "string"
        },
        "CreditorAgent": {
          "SchemeName": "string",
          "Identification": "string",
          "Name": "string"
        },
        "CreditorAccount": {
          "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

GET StandingOrders of one account

GET /openbanking/{tenantId}/v3.1/aisp/accounts/{accountId}/standing-orders

Recurring transfers drawn on the consented accounts.

Headers

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

Path parameters

Name
`tenantId`
`accountId`

Example

Response: ObResponseObStandingOrderData

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

{
  "Data": {
    "StandingOrder": [
      {
        "AccountId": "string",
        "StandingOrderId": "string",
        "Frequency": "string",
        "Reference": "b3f1c2d4-5e6a-4b7c-8d9e-0f1a2b3c4d5e",
        "FirstPaymentDateTime": "string",
        "NextPaymentDateTime": "string",
        "FinalPaymentDateTime": "string",
        "NumberOfPayments": "string",
        "StandingOrderStatusCode": "string",
        "FirstPaymentAmount": {
          "Amount": "string",
          "Currency": "string"
        },
        "NextPaymentAmount": {
          "Amount": "string",
          "Currency": "string"
        },
        "CreditorAgent": {
          "SchemeName": "string",
          "Identification": "string",
          "Name": "string"
        },
        "CreditorAccount": {
          "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

GET Monthly statements of one account

GET /openbanking/{tenantId}/v3.1/aisp/accounts/{accountId}/statements

Headers

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

Path parameters

Name
`tenantId`
`accountId`

Example

Response: ObResponseObStatementData

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

{
  "Data": {
    "Statement": [
      {
        "AccountId": "string",
        "StatementId": "string",
        "StatementReference": "b3f1c2d4-5e6a-4b7c-8d9e-0f1a2b3c4d5e",
        "Type": "string",
        "StartDateTime": "string",
        "EndDateTime": "string",
        "CreationDateTime": "string",
        "StatementAmount": [
          {
            "Amount": {
              "Amount": "string",
              "Currency": "string"
            },
            "CreditDebitIndicator": "string",
            "Type": "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 One statement

GET /openbanking/{tenantId}/v3.1/aisp/accounts/{accountId}/statements/{statementId}

Headers

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

Path parameters

Name
`tenantId`
`accountId`
`statementId`

Example

Response: ObResponseObStatementData

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

{
  "Data": {
    "Statement": [
      {
        "AccountId": "string",
        "StatementId": "string",
        "StatementReference": "b3f1c2d4-5e6a-4b7c-8d9e-0f1a2b3c4d5e",
        "Type": "string",
        "StartDateTime": "string",
        "EndDateTime": "string",
        "CreationDateTime": "string",
        "StatementAmount": [
          {
            "Amount": {
              "Amount": "string",
              "Currency": "string"
            },
            "CreditDebitIndicator": "string",
            "Type": "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 statement file

GET /openbanking/{tenantId}/v3.1/aisp/accounts/{accountId}/statements/{statementId}/file

ReadStatementsDetail. A CSV of the month's booked transactions, byte-identical on every read.

Headers

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

Path parameters

Name
`tenantId`
`accountId`
`statementId`

Example

Response: string

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

"string"

Responses

Status	When
`200`	OK

GET The transactions on one statement

GET /openbanking/{tenantId}/v3.1/aisp/accounts/{accountId}/statements/{statementId}/transactions

Needs a statement permission and a transaction permission; credits and debits are filtered as on /transactions.

Headers

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

Path parameters

Name
`tenantId`
`accountId`
`statementId`

Query parameters

Name	Default
`page`	Optional

Example

Response: ObResponseObTransactionData

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

{
  "Data": {
    "Transaction": [
      {
        "AccountId": "string",
        "TransactionId": "string",
        "TransactionReference": "b3f1c2d4-5e6a-4b7c-8d9e-0f1a2b3c4d5e",
        "Amount": {
          "Amount": "string",
          "Currency": "string"
        },
        "CreditDebitIndicator": "string",
        "Status": "string",
        "BookingDateTime": "string",
        "ValueDateTime": "string",
        "TransactionInformation": "string",
        "BankTransactionCode": {
          "Code": "string",
          "SubCode": "string"
        },
        "ProprietaryBankTransactionCode": {
          "Code": "string",
          "Issuer": "string"
        },
        "CreditorAccount": {
          "SchemeName": "string",
          "Identification": "string",
          "Name": "string",
          "SecondaryIdentification": "string"
        },
        "DebtorAccount": {
          "SchemeName": "string",
          "Identification": "string",
          "Name": "string",
          "SecondaryIdentification": "string"
        },
        "Balance": {
          "Amount": {
            "Amount": "string",
            "Currency": "string"
          },
          "CreditDebitIndicator": "string",
          "Type": "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 Transactions of one account

GET /openbanking/{tenantId}/v3.1/aisp/accounts/{accountId}/transactions

Headers

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

Path parameters

Name
`tenantId`
`accountId`

Query parameters

Name	Default
`fromBookingDateTime`	Optional
`toBookingDateTime`	Optional
`page`	Optional

Example

Response: ObResponseObTransactionData

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

{
  "Data": {
    "Transaction": [
      {
        "AccountId": "string",
        "TransactionId": "string",
        "TransactionReference": "b3f1c2d4-5e6a-4b7c-8d9e-0f1a2b3c4d5e",
        "Amount": {
          "Amount": "string",
          "Currency": "string"
        },
        "CreditDebitIndicator": "string",
        "Status": "string",
        "BookingDateTime": "string",
        "ValueDateTime": "string",
        "TransactionInformation": "string",
        "BankTransactionCode": {
          "Code": "string",
          "SubCode": "string"
        },
        "ProprietaryBankTransactionCode": {
          "Code": "string",
          "Issuer": "string"
        },
        "CreditorAccount": {
          "SchemeName": "string",
          "Identification": "string",
          "Name": "string",
          "SecondaryIdentification": "string"
        },
        "DebtorAccount": {
          "SchemeName": "string",
          "Identification": "string",
          "Name": "string",
          "SecondaryIdentification": "string"
        },
        "Balance": {
          "Amount": {
            "Amount": "string",
            "Currency": "string"
          },
          "CreditDebitIndicator": "string",
          "Type": "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 Balances of every account the consent covers

GET /openbanking/{tenantId}/v3.1/aisp/balances

InterimAvailable is the spendable balance. ClosingBooked adds liened and committed money. Balances are read live and never cached.

Headers

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

Path parameters

Name
`tenantId`

Example

Response: ObResponseObBalanceData

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

{
  "Data": {
    "Balance": [
      {
        "AccountId": "string",
        "Amount": {
          "Amount": "string",
          "Currency": "string"
        },
        "CreditDebitIndicator": "string",
        "Type": "string",
        "DateTime": "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 Beneficiaries

GET /openbanking/{tenantId}/v3.1/aisp/beneficiaries

Saved payees. Bridge saves payees per customer, not per account, so the account-scoped form returns the same payees for any account the consent covers.

Headers

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

Path parameters

Name
`tenantId`

Example

Response: ObResponseObBeneficiaryData

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

{
  "Data": {
    "Beneficiary": [
      {
        "BeneficiaryId": "string",
        "BeneficiaryType": "string",
        "Reference": "b3f1c2d4-5e6a-4b7c-8d9e-0f1a2b3c4d5e",
        "CreditorAgent": {
          "SchemeName": "string",
          "Identification": "string",
          "Name": "string"
        },
        "CreditorAccount": {
          "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

GET DirectDebits

GET /openbanking/{tenantId}/v3.1/aisp/direct-debits

Always an empty collection today: Bridge accounts carry no direct-debit mandates.

Headers

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

Path parameters

Name
`tenantId`

Example

Response: ObResponseObDirectDebitData

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

{
  "Data": {
    "DirectDebit": [
      "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 Offers

GET /openbanking/{tenantId}/v3.1/aisp/offers

Always an empty collection: Bridge has no offers.

Headers

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

Path parameters

Name
`tenantId`

Example

Response: ObResponseObOfferData

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

{
  "Data": {
    "Offer": [
      "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 customer who authorised the consent

GET /openbanking/{tenantId}/v3.1/aisp/party

ReadPartyPSU. Six fields at most: PartyId, PartyType, Name, EmailAddress, Mobile and Address, and nothing else identity holds. Refused when the identity consent recorded alongside this consent has been revoked.

Headers

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

Path parameters

Name
`tenantId`

Example

Response: ObResponseObPartyData

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

{
  "Data": {
    "Party": {
      "PartyId": "string",
      "PartyType": "string",
      "Name": "string",
      "EmailAddress": "ada@example.com",
      "Mobile": "string",
      "Address": [
        {
          "AddressType": "string",
          "StreetName": "string",
          "BuildingNumber": "string",
          "PostCode": "string",
          "TownName": "string",
          "CountrySubDivision": "string",
          "Country": "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 Products

GET /openbanking/{tenantId}/v3.1/aisp/products

The live catalogue product for each consented account, matched on account type and currency. An account whose type has no published product is simply absent.

Headers

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

Path parameters

Name
`tenantId`

Example

Response: ObResponseObProductData

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

{
  "Data": {
    "Product": [
      "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 ScheduledPayments

GET /openbanking/{tenantId}/v3.1/aisp/scheduled-payments

One-off future-dated transfers drawn on the consented accounts.

Headers

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

Path parameters

Name
`tenantId`

Example

Response: ObResponseObScheduledPaymentData

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

{
  "Data": {
    "ScheduledPayment": [
      {
        "AccountId": "string",
        "ScheduledPaymentId": "string",
        "ScheduledPaymentDateTime": "string",
        "ScheduledType": "string",
        "Reference": "b3f1c2d4-5e6a-4b7c-8d9e-0f1a2b3c4d5e",
        "InstructedAmount": {
          "Amount": "string",
          "Currency": "string"
        },
        "CreditorAgent": {
          "SchemeName": "string",
          "Identification": "string",
          "Name": "string"
        },
        "CreditorAccount": {
          "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

GET StandingOrders

GET /openbanking/{tenantId}/v3.1/aisp/standing-orders

Recurring transfers drawn on the consented accounts.

Headers

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

Path parameters

Name
`tenantId`

Example

Response: ObResponseObStandingOrderData

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

{
  "Data": {
    "StandingOrder": [
      {
        "AccountId": "string",
        "StandingOrderId": "string",
        "Frequency": "string",
        "Reference": "b3f1c2d4-5e6a-4b7c-8d9e-0f1a2b3c4d5e",
        "FirstPaymentDateTime": "string",
        "NextPaymentDateTime": "string",
        "FinalPaymentDateTime": "string",
        "NumberOfPayments": "string",
        "StandingOrderStatusCode": "string",
        "FirstPaymentAmount": {
          "Amount": "string",
          "Currency": "string"
        },
        "NextPaymentAmount": {
          "Amount": "string",
          "Currency": "string"
        },
        "CreditorAgent": {
          "SchemeName": "string",
          "Identification": "string",
          "Name": "string"
        },
        "CreditorAccount": {
          "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

GET Monthly statements of every account the consent covers

GET /openbanking/{tenantId}/v3.1/aisp/statements

One statement per closed calendar month, at most 24, and only months that lie wholly inside the consent's transaction window. A statement is frozen the first time it is read, so the same StatementId returns the same figures and file forever. StatementAmount needs ReadStatementsDetail.

Headers

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

Path parameters

Name
`tenantId`

Example

Response: ObResponseObStatementData

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

{
  "Data": {
    "Statement": [
      {
        "AccountId": "string",
        "StatementId": "string",
        "StatementReference": "b3f1c2d4-5e6a-4b7c-8d9e-0f1a2b3c4d5e",
        "Type": "string",
        "StartDateTime": "string",
        "EndDateTime": "string",
        "CreationDateTime": "string",
        "StatementAmount": [
          {
            "Amount": {
              "Amount": "string",
              "Currency": "string"
            },
            "CreditDebitIndicator": "string",
            "Type": "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 Transactions of every account the consent covers

GET /openbanking/{tenantId}/v3.1/aisp/transactions

Pages never span two accounts, and the window is clamped to the consent's transaction window rather than refused. Credits and debits appear only if the consent granted that direction.

Headers

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

Path parameters

Name
`tenantId`

Query parameters

Name	Default
`fromBookingDateTime`	Optional
`toBookingDateTime`	Optional
`page`	Optional

Example

Response: ObResponseObTransactionData

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

{
  "Data": {
    "Transaction": [
      {
        "AccountId": "string",
        "TransactionId": "string",
        "TransactionReference": "b3f1c2d4-5e6a-4b7c-8d9e-0f1a2b3c4d5e",
        "Amount": {
          "Amount": "string",
          "Currency": "string"
        },
        "CreditDebitIndicator": "string",
        "Status": "string",
        "BookingDateTime": "string",
        "ValueDateTime": "string",
        "TransactionInformation": "string",
        "BankTransactionCode": {
          "Code": "string",
          "SubCode": "string"
        },
        "ProprietaryBankTransactionCode": {
          "Code": "string",
          "Issuer": "string"
        },
        "CreditorAccount": {
          "SchemeName": "string",
          "Identification": "string",
          "Name": "string",
          "SecondaryIdentification": "string"
        },
        "DebtorAccount": {
          "SchemeName": "string",
          "Identification": "string",
          "Name": "string",
          "SecondaryIdentification": "string"
        },
        "Balance": {
          "Amount": {
            "Amount": "string",
            "Currency": "string"
          },
          "CreditDebitIndicator": "string",
          "Type": "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