right logo image
right logo image
Log on
⯆

API Explorer

Log off

v5.1.0 (533 APIs)

API Host: https://obp-api-sandbox.nmbbank.co.tz
Bank
Accounts
Views
Counterparties
Transactions

Create Transaction Attribute

Create Transaction Attribute

The type field must be one of "STRING", "INTEGER", "DOUBLE" or DATE_WITH_DAY"

Authentication is Mandatory

URL Parameters:

ACCOUNT_ID: 8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0

BANK_ID: gh.29.uk

TRANSACTION_ID: 2fg8a7e4-6d02-40e3-a129-0b2bf89de8ub

JSON request body fields:

name: ACCOUNT_MANAGEMENT_FEE

type:

value: 5987953

JSON response body fields:

name: ACCOUNT_MANAGEMENT_FEE

transaction_attribute_id: 7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh

type:

value: 5987953

Typical Successful Response: 

								
									
{
  "transaction_attribute_id":"7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh",
  "name":"HOUSE_RENT",
  "type":"DATE_WITH_DAY",
  "value":"123456789"
}
Required Roles:
  • CanCreateTransactionAttributeAtOneBank - Please login to request this Role
Validations:
  • Required JSON Validation: No
  • Allowed Authentication Types: Not set
Possible Errors:
  • OBP-20001: User not logged in. Authentication is required!
  • OBP-30001: Bank not found. Please specify a valid value for BANK_ID.
  • OBP-30018: Bank Account not found. Please specify valid values for BANK_ID and ACCOUNT_ID.
  • OBP-10001: Incorrect json format.
  • OBP-50000: Unknown Error.
  • OBP-20006: User is missing one or more roles:
Connector Methods:
Version: OBPv4.0.0, function_name: by createTransactionAttribute, operation_id: OBPv4.0.0-createTransactionAttribute Tags: Transaction,

Create or Update Transaction Attribute Definition

Create or Update Transaction Attribute Definition

The category field must be Transaction

The type field must be one of; DOUBLE, STRING, INTEGER and DATE_WITH_DAY

Authentication is Mandatory

URL Parameters:

BANK_ID: gh.29.uk

JSON response body fields:

alias:

attribute_definition_id:

bank_id: gh.29.uk

can_be_seen_on_views: false

category:

description: Description of the object. Maximum length is 2000. It can be any characters here.

is_active: false

name: ACCOUNT_MANAGEMENT_FEE

type:

Typical Successful Response: 

								
									
{
  "attribute_definition_id":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1",
  "bank_id":"gh.29.uk",
  "name":"SPECIAL_TAX_NUMBER",
  "category":"Transaction",
  "type":"STRING",
  "description":"description",
  "alias":"STRING",
  "can_be_seen_on_views":["bank"],
  "is_active":true
}
Required Roles:
  • CanCreateTransactionAttributeDefinitionAtOneBank - Please login to request this Role
Validations:
  • Required JSON Validation: No
  • Allowed Authentication Types: Not set
Possible Errors:
  • OBP-20001: User not logged in. Authentication is required!
  • OBP-30001: Bank not found. Please specify a valid value for BANK_ID.
  • OBP-10001: Incorrect json format.
  • OBP-50000: Unknown Error.
  • OBP-20006: User is missing one or more roles:
Connector Methods:
Version: OBPv4.0.0, function_name: by createOrUpdateTransactionAttributeDefinition, operation_id: OBPv4.0.0-createOrUpdateTransactionAttributeDefinition Tags: Transaction,

Delete Transaction Attribute Definition

Delete Transaction Attribute Definition by ATTRIBUTE_DEFINITION_ID

Authentication is Mandatory

URL Parameters:

ATTRIBUTE_DEFINITION_ID:

BANK_ID: gh.29.uk

JSON response body fields:

Typical Successful Response:
Required Roles:
  • CanDeleteTransactionAttributeDefinitionAtOneBank - Please login to request this Role
Validations:
  • Required JSON Validation: No
  • Allowed Authentication Types: Not set
Possible Errors:
  • OBP-20001: User not logged in. Authentication is required!
  • OBP-30001: Bank not found. Please specify a valid value for BANK_ID.
  • OBP-50000: Unknown Error.
  • OBP-20006: User is missing one or more roles:
Connector Methods:
Version: OBPv4.0.0, function_name: by deleteTransactionAttributeDefinition, operation_id: OBPv4.0.0-deleteTransactionAttributeDefinition Tags: Transaction,

Delete Transaction Cascade

Delete a Transaction Cascade specified by TRANSACTION_ID.

Authentication is Mandatory

URL Parameters:

ACCOUNT_ID: 8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0

BANK_ID: gh.29.uk

TRANSACTION_ID: 2fg8a7e4-6d02-40e3-a129-0b2bf89de8ub

JSON response body fields:

Typical Successful Response:
Required Roles:
  • CanDeleteTransactionCascade - Please login to request this Role
Validations:
  • Required JSON Validation: No
  • Allowed Authentication Types: Not set
Possible Errors:
  • OBP-20001: User not logged in. Authentication is required!
  • OBP-30001: Bank not found. Please specify a valid value for BANK_ID.
  • OBP-30018: Bank Account not found. Please specify valid values for BANK_ID and ACCOUNT_ID.
  • OBP-20006: User is missing one or more roles:
  • OBP-50000: Unknown Error.
Connector Methods:
Version: OBPv4.0.0, function_name: by deleteTransactionCascade, operation_id: OBPv4.0.0-deleteTransactionCascade Tags: Transaction,

Get Balancing Transaction

Get Balancing Transaction

Authentication is Mandatory

URL Parameters:

TRANSACTION_ID: 2fg8a7e4-6d02-40e3-a129-0b2bf89de8ub

JSON response body fields:

account_id: 8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0

bank_id: gh.29.uk

credit_transaction: credit_transaction

debit_transaction: debit_transaction

transaction_id: 2fg8a7e4-6d02-40e3-a129-0b2bf89de8ub

transaction_request: transaction_request

transaction_request_id: 8138a7e4-6d02-40e3-a129-0b2bf89de9f1

Typical Successful Response: 

								
									
{
  "transaction_request":{
    "bank_id":"gh.29.uk",
    "account_id":"8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0",
    "transaction_request_id":"8138a7e4-6d02-40e3-a129-0b2bf89de9f1"
  },
  "debit_transaction":{
    "bank_id":"gh.29.uk",
    "account_id":"8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0",
    "transaction_id":"2fg8a7e4-6d02-40e3-a129-0b2bf89de8ub"
  },
  "credit_transaction":{
    "bank_id":"gh.29.uk",
    "account_id":"8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0",
    "transaction_id":"2fg8a7e4-6d02-40e3-a129-0b2bf89de8ub"
  }
}
Validations:
  • Required JSON Validation: No
  • Allowed Authentication Types: Not set
Possible Errors:
  • OBP-20001: User not logged in. Authentication is required!
  • OBP-10001: Incorrect json format.
  • OBP-50000: Unknown Error.
Connector Methods:
Version: OBPv4.0.0, function_name: by getBalancingTransaction, operation_id: OBPv4.0.0-getBalancingTransaction Tags: Transaction,

Get Double Entry Transaction

Get Double Entry Transaction

This endpoint can be used to see the double entry transactions. It returns the bank_id, account_id and transaction_id
for the debit end the credit transaction. The other side account can be a settlement account or an OBP account.

The endpoint also provide the transaction_request object which contains the bank_id, account_id and
transaction_request_id of the transaction request at the origin of the transaction. Please note that if none
transaction request is at the origin of the transaction, the transaction_request object will be null.

Authentication is Mandatory

URL Parameters:

ACCOUNT_ID: 8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0

BANK_ID: gh.29.uk

TRANSACTION_ID: 2fg8a7e4-6d02-40e3-a129-0b2bf89de8ub

VIEW_ID: owner

JSON response body fields:

account_id: 8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0

bank_id: gh.29.uk

credit_transaction: credit_transaction

debit_transaction: debit_transaction

transaction_id: 2fg8a7e4-6d02-40e3-a129-0b2bf89de8ub

transaction_request: transaction_request

transaction_request_id: 8138a7e4-6d02-40e3-a129-0b2bf89de9f1

Typical Successful Response: 

								
									
{
  "transaction_request":{
    "bank_id":"gh.29.uk",
    "account_id":"8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0",
    "transaction_request_id":"8138a7e4-6d02-40e3-a129-0b2bf89de9f1"
  },
  "debit_transaction":{
    "bank_id":"gh.29.uk",
    "account_id":"8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0",
    "transaction_id":"2fg8a7e4-6d02-40e3-a129-0b2bf89de8ub"
  },
  "credit_transaction":{
    "bank_id":"gh.29.uk",
    "account_id":"8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0",
    "transaction_id":"2fg8a7e4-6d02-40e3-a129-0b2bf89de8ub"
  }
}
Required Roles:
  • CanGetDoubleEntryTransactionAtAnyBank - Please login to request this Role
  • CanGetDoubleEntryTransactionAtOneBank - Please login to request this Role
Validations:
  • Required JSON Validation: No
  • Allowed Authentication Types: Not set
Possible Errors:
  • OBP-20001: User not logged in. Authentication is required!
  • OBP-30001: Bank not found. Please specify a valid value for BANK_ID.
  • OBP-30018: Bank Account not found. Please specify valid values for BANK_ID and ACCOUNT_ID.
  • OBP-20017: Current user does not have access to the view. Please specify a valid value for VIEW_ID.
  • OBP-10001: Incorrect json format.
  • OBP-50000: Unknown Error.
  • OBP-20006: User is missing one or more roles:
Connector Methods:
Version: OBPv4.0.0, function_name: by getDoubleEntryTransaction, operation_id: OBPv4.0.0-getDoubleEntryTransaction Tags: Transaction,

Get Firehose Transactions for Account

Get Transactions for an Account that has a firehose View.

Allows bulk access to an account's transactions.
User must have the CanUseFirehoseAtAnyBank Role

To find ACCOUNT_IDs, use the getFirehoseAccountsAtOneBank call.

For VIEW_ID try 'owner'

Possible custom url parameters for pagination:

  • limit=NUMBER ==> default value: 50
  • offset=NUMBER ==> default value: 0

eg1:?limit=100&offset=0

  • sort_direction=ASC/DESC ==> default value: DESC.

eg2:?limit=100&offset=0&sort_direction=ASC

  • from_date=DATE => example value: 1970-01-01T00:00:00.000Z. NOTE! The default value is one year ago (1970-01-01T00:00:00.000Z).
  • to_date=DATE => example value: 2024-11-20T21:32:27.694Z. NOTE! The default value is now (2024-11-20T21:32:27.694Z).

Date format parameter: yyyy-MM-dd'T'HH:mm:ss.SSS'Z'(1100-01-01T01:01:01.000Z) ==> time zone is UTC.

eg3:?sort_direction=ASC&limit=100&offset=0&from_date=1100-01-01T01:01:01.000Z&to_date=1100-01-01T01:01:01.000Z

Authentication is Mandatory

URL Parameters:

ACCOUNT_ID: 8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0

BANK_ID: gh.29.uk

VIEW_ID: owner

JSON response body fields:

URL: http://www.example.com/id-docs/123/image.png

account_routings:

address:

amount: 10.12

bank_routing:

comments:

completed: 2020-01-27

corporate_location: 10

currency: EUR

date: 2020-01-27

description: Description of the object. Maximum length is 2000. It can be any characters here.

details:

display_name:

holder:

holders:

id: d8839721-ad8f-45dd-9f78-2080414b93f9

image_URL:

images:

is_alias:

label: My Account

latitude: 38.8951

longitude: -77.0364

metadata:

more_info: More information about this fee

name: ACCOUNT_MANAGEMENT_FEE

narrative:

new_balance: 20

open_corporates_URL:

other_account:

physical_location:

posted: 2020-01-27

private_alias:

provider: ETHEREUM

public_alias:

scheme: scheme value

tags: Create-My-User

this_account:

transaction_attribute_id: 7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh

transaction_attributes:

transactions:

type:

user:

value: 5987953

where:

Typical Successful Response: 

								
									
{
  "transactions":[{
    "id":"String",
    "this_account":{
      "id":"String",
      "bank_routing":{
        "scheme":"scheme value",
        "address":""
      },
      "account_routings":[{
        "scheme":"AccountNumber",
        "address":"4930396"
      }],
      "holders":[{
        "name":"OBP",
        "is_alias":true
      }]
    },
    "other_account":{
      "id":"5995d6a2-01b3-423c-a173-5481df49bdaf",
      "holder":{
        "name":"OBP",
        "is_alias":true
      },
      "bank_routing":{
        "scheme":"scheme value",
        "address":""
      },
      "account_routings":[{
        "scheme":"AccountNumber",
        "address":"4930396"
      }],
      "metadata":{
        "public_alias":"NONE",
        "private_alias":"NONE",
        "more_info":"www.openbankproject.com",
        "URL":"www.openbankproject.com",
        "image_URL":"www.openbankproject.com",
        "open_corporates_URL":"www.openbankproject.com",
        "corporate_location":{
          "latitude":1.231,
          "longitude":1.231,
          "date":"1100-01-01T00:00:00Z",
          "user":{
            "id":"5995d6a2-01b3-423c-a173-5481df49bdaf",
            "provider":"http://127.0.0.1:8080",
            "display_name":"OBP"
          }
        },
        "physical_location":{
          "latitude":1.231,
          "longitude":1.231,
          "date":"1100-01-01T00:00:00Z",
          "user":{
            "id":"5995d6a2-01b3-423c-a173-5481df49bdaf",
            "provider":"http://127.0.0.1:8080",
            "display_name":"OBP"
          }
        }
      }
    },
    "details":{
      "type":"AC",
      "description":"this is for family",
      "posted":"1100-01-01T00:00:00Z",
      "completed":"1100-01-01T00:00:00Z",
      "new_balance":{
        "currency":"EUR",
        "amount":"0"
      },
      "value":{
        "currency":"EUR",
        "amount":"0"
      }
    },
    "metadata":{
      "narrative":"NONE",
      "comments":[{
        "id":"5995d6a2-01b3-423c-a173-5481df49bdaf",
        "value":"OBP",
        "date":"1100-01-01T00:00:00Z",
        "user":{
          "id":"5995d6a2-01b3-423c-a173-5481df49bdaf",
          "provider":"http://127.0.0.1:8080",
          "display_name":"OBP"
        }
      }],
      "tags":[{
        "id":"5995d6a2-01b3-423c-a173-5481df49bdaf",
        "value":"OBP",
        "date":"1100-01-01T00:00:00Z",
        "user":{
          "id":"5995d6a2-01b3-423c-a173-5481df49bdaf",
          "provider":"http://127.0.0.1:8080",
          "display_name":"OBP"
        }
      }],
      "images":[{
        "id":"5995d6a2-01b3-423c-a173-5481df49bdaf",
        "label":"NONE",
        "URL":"www.openbankproject.com",
        "date":"1100-01-01T00:00:00Z",
        "user":{
          "id":"5995d6a2-01b3-423c-a173-5481df49bdaf",
          "provider":"http://127.0.0.1:8080",
          "display_name":"OBP"
        }
      }],
      "where":{
        "latitude":1.231,
        "longitude":1.231,
        "date":"1100-01-01T00:00:00Z",
        "user":{
          "id":"5995d6a2-01b3-423c-a173-5481df49bdaf",
          "provider":"http://127.0.0.1:8080",
          "display_name":"OBP"
        }
      }
    },
    "transaction_attributes":[{
      "transaction_attribute_id":"7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh",
      "name":"HOUSE_RENT",
      "type":"DATE_WITH_DAY",
      "value":"123456789"
    }]
  }]
}
Required Roles:
  • CanUseAccountFirehoseAtAnyBank - Please login to request this Role
  • CanUseAccountFirehose - Please login to request this Role
Validations:
  • Required JSON Validation: No
  • Allowed Authentication Types: Not set
Possible Errors:
  • OBP-20001: User not logged in. Authentication is required!
  • OBP-00009: Account firehose is not allowed on this instance. Please set allow_account_firehose = true in props files.
  • OBP-20006: User is missing one or more roles:
  • OBP-50000: Unknown Error.
Connector Methods:
Version: OBPv3.0.0, function_name: by getFirehoseTransactionsForBankAccount, operation_id: OBPv3.0.0-getFirehoseTransactionsForBankAccount Tags: Transaction, Account-Firehose, Transaction-Firehose, FirehoseData,

Get Other Account of Transaction

Get other account of a transaction.
Returns details of the other party involved in the transaction, moderated by the view (VIEW_ID).
Authentication via OAuth is required if the view is not public.

Authentication is Optional

URL Parameters:

ACCOUNT_ID: 8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0

BANK_ID: gh.29.uk

TRANSACTION_ID: 2fg8a7e4-6d02-40e3-a129-0b2bf89de8ub

VIEW_ID: owner

JSON response body fields:

IBAN: DE91 1000 0000 0123 4567 89

URL: http://www.example.com/id-docs/123/image.png

bank:

corporate_location: 10

date: 2020-01-27

display_name:

holder:

id: d8839721-ad8f-45dd-9f78-2080414b93f9

image_URL:

is_alias:

kind:

latitude: 38.8951

longitude: -77.0364

metadata:

more_info: More information about this fee

name: ACCOUNT_MANAGEMENT_FEE

national_identifier:

number:

open_corporates_URL:

physical_location:

private_alias:

provider: ETHEREUM

public_alias:

swift_bic:

user:

Typical Successful Response: 

								
									
{
  "id":"5995d6a2-01b3-423c-a173-5481df49bdaf",
  "holder":{
    "name":"OBP",
    "is_alias":true
  },
  "number":"123",
  "kind":"3456",
  "IBAN":"UK234DB",
  "swift_bic":"UK12321DB",
  "bank":{
    "national_identifier":"OBP",
    "name":"OBP"
  },
  "metadata":{
    "public_alias":"NONE",
    "private_alias":"NONE",
    "more_info":"www.openbankproject.com",
    "URL":"www.openbankproject.com",
    "image_URL":"www.openbankproject.com",
    "open_corporates_URL":"www.openbankproject.com",
    "corporate_location":{
      "latitude":1.231,
      "longitude":1.231,
      "date":"1100-01-01T00:00:00Z",
      "user":{
        "id":"5995d6a2-01b3-423c-a173-5481df49bdaf",
        "provider":"http://127.0.0.1:8080",
        "display_name":"OBP"
      }
    },
    "physical_location":{
      "latitude":1.231,
      "longitude":1.231,
      "date":"1100-01-01T00:00:00Z",
      "user":{
        "id":"5995d6a2-01b3-423c-a173-5481df49bdaf",
        "provider":"http://127.0.0.1:8080",
        "display_name":"OBP"
      }
    }
  }
}
Validations:
  • Required JSON Validation: No
  • Allowed Authentication Types: Not set
Possible Errors:
  • OBP-30018: Bank Account not found. Please specify valid values for BANK_ID and ACCOUNT_ID.
  • OBP-50000: Unknown Error.
Connector Methods:
Version: OBPv1.2.1, function_name: by getOtherAccountForTransaction, operation_id: OBPv1.2.1-getOtherAccountForTransaction Tags: Transaction, Counterparty,

Get Transaction Attribute By Id

Get Transaction Attribute By Id

Authentication is Mandatory

URL Parameters:

ACCOUNT_ID: 8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0

ATTRIBUTE_ID:

BANK_ID: gh.29.uk

TRANSACTION_ID: 2fg8a7e4-6d02-40e3-a129-0b2bf89de8ub

JSON response body fields:

name: ACCOUNT_MANAGEMENT_FEE

transaction_attribute_id: 7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh

type:

value: 5987953

Typical Successful Response: 

								
									
{
  "transaction_attribute_id":"7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh",
  "name":"HOUSE_RENT",
  "type":"DATE_WITH_DAY",
  "value":"123456789"
}
Required Roles:
  • CanGetTransactionAttributeAtOneBank - Please login to request this Role
Validations:
  • Required JSON Validation: No
  • Allowed Authentication Types: Not set
Possible Errors:
  • OBP-20001: User not logged in. Authentication is required!
  • OBP-30001: Bank not found. Please specify a valid value for BANK_ID.
  • OBP-30018: Bank Account not found. Please specify valid values for BANK_ID and ACCOUNT_ID.
  • OBP-10001: Incorrect json format.
  • OBP-50000: Unknown Error.
  • OBP-20006: User is missing one or more roles:
Connector Methods:
Version: OBPv4.0.0, function_name: by getTransactionAttributeById, operation_id: OBPv4.0.0-getTransactionAttributeById Tags: Transaction,

Get Transaction Attribute Definition

Get Transaction Attribute Definition

Authentication is Mandatory

URL Parameters:

BANK_ID: gh.29.uk

JSON response body fields:

alias:

attribute_definition_id:

attributes: attribute value in form of (name, value)

bank_id: gh.29.uk

can_be_seen_on_views: false

category:

description: Description of the object. Maximum length is 2000. It can be any characters here.

is_active: false

name: ACCOUNT_MANAGEMENT_FEE

type:

Typical Successful Response: 

								
									
{
  "attributes":[{
    "attribute_definition_id":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1",
    "bank_id":"gh.29.uk",
    "name":"SPECIAL_TAX_NUMBER",
    "category":"Transaction",
    "type":"STRING",
    "description":"description",
    "alias":"STRING",
    "can_be_seen_on_views":["bank"],
    "is_active":true
  }]
}
Required Roles:
  • CanGetTransactionAttributeDefinitionAtOneBank - Please login to request this Role
Validations:
  • Required JSON Validation: No
  • Allowed Authentication Types: Not set
Possible Errors:
  • OBP-20001: User not logged in. Authentication is required!
  • OBP-30001: Bank not found. Please specify a valid value for BANK_ID.
  • OBP-50000: Unknown Error.
  • OBP-20006: User is missing one or more roles:
Connector Methods:
Version: OBPv4.0.0, function_name: by getTransactionAttributeDefinition, operation_id: OBPv4.0.0-getTransactionAttributeDefinition Tags: Transaction,

Get Transaction Attributes

Get Transaction Attributes

Authentication is Mandatory

URL Parameters:

ACCOUNT_ID: 8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0

BANK_ID: gh.29.uk

TRANSACTION_ID: 2fg8a7e4-6d02-40e3-a129-0b2bf89de8ub

JSON response body fields:

name: ACCOUNT_MANAGEMENT_FEE

transaction_attribute_id: 7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh

transaction_attributes:

type:

value: 5987953

Typical Successful Response: 

								
									
{
  "transaction_attributes":[{
    "transaction_attribute_id":"7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh",
    "name":"HOUSE_RENT",
    "type":"DATE_WITH_DAY",
    "value":"123456789"
  }]
}
Required Roles:
  • CanGetTransactionAttributesAtOneBank - Please login to request this Role
Validations:
  • Required JSON Validation: No
  • Allowed Authentication Types: Not set
Possible Errors:
  • OBP-20001: User not logged in. Authentication is required!
  • OBP-30001: Bank not found. Please specify a valid value for BANK_ID.
  • OBP-30018: Bank Account not found. Please specify valid values for BANK_ID and ACCOUNT_ID.
  • OBP-10001: Incorrect json format.
  • OBP-50000: Unknown Error.
  • OBP-20006: User is missing one or more roles:
Connector Methods:
Version: OBPv4.0.0, function_name: by getTransactionAttributes, operation_id: OBPv4.0.0-getTransactionAttributes Tags: Transaction,

Get Transaction by Id

Returns one transaction specified by TRANSACTION_ID of the account ACCOUNT_ID and moderated by the view (VIEW_ID).

Authentication is Optional
Authentication is required if the view is not public.

URL Parameters:

ACCOUNT_ID: 8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0

BANK_ID: gh.29.uk

TRANSACTION_ID: 2fg8a7e4-6d02-40e3-a129-0b2bf89de8ub

VIEW_ID: owner

JSON response body fields:

URL: http://www.example.com/id-docs/123/image.png

account_routings:

address:

amount: 10.12

bank_routing:

comments:

completed: 2020-01-27

corporate_location: 10

currency: EUR

date: 2020-01-27

description: Description of the object. Maximum length is 2000. It can be any characters here.

details:

display_name:

holder:

holders:

id: d8839721-ad8f-45dd-9f78-2080414b93f9

image_URL:

images:

is_alias:

label: My Account

latitude: 38.8951

longitude: -77.0364

metadata:

more_info: More information about this fee

name: ACCOUNT_MANAGEMENT_FEE

narrative:

new_balance: 20

open_corporates_URL:

other_account:

physical_location:

posted: 2020-01-27

private_alias:

provider: ETHEREUM

public_alias:

scheme: scheme value

tags: Create-My-User

this_account:

transaction_attribute_id: 7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh

transaction_attributes:

type:

user:

value: 5987953

where:

Typical Successful Response: 

								
									
{
  "id":"String",
  "this_account":{
    "id":"String",
    "bank_routing":{
      "scheme":"scheme value",
      "address":""
    },
    "account_routings":[{
      "scheme":"AccountNumber",
      "address":"4930396"
    }],
    "holders":[{
      "name":"OBP",
      "is_alias":true
    }]
  },
  "other_account":{
    "id":"5995d6a2-01b3-423c-a173-5481df49bdaf",
    "holder":{
      "name":"OBP",
      "is_alias":true
    },
    "bank_routing":{
      "scheme":"scheme value",
      "address":""
    },
    "account_routings":[{
      "scheme":"AccountNumber",
      "address":"4930396"
    }],
    "metadata":{
      "public_alias":"NONE",
      "private_alias":"NONE",
      "more_info":"www.openbankproject.com",
      "URL":"www.openbankproject.com",
      "image_URL":"www.openbankproject.com",
      "open_corporates_URL":"www.openbankproject.com",
      "corporate_location":{
        "latitude":1.231,
        "longitude":1.231,
        "date":"1100-01-01T00:00:00Z",
        "user":{
          "id":"5995d6a2-01b3-423c-a173-5481df49bdaf",
          "provider":"http://127.0.0.1:8080",
          "display_name":"OBP"
        }
      },
      "physical_location":{
        "latitude":1.231,
        "longitude":1.231,
        "date":"1100-01-01T00:00:00Z",
        "user":{
          "id":"5995d6a2-01b3-423c-a173-5481df49bdaf",
          "provider":"http://127.0.0.1:8080",
          "display_name":"OBP"
        }
      }
    }
  },
  "details":{
    "type":"AC",
    "description":"this is for family",
    "posted":"1100-01-01T00:00:00Z",
    "completed":"1100-01-01T00:00:00Z",
    "new_balance":{
      "currency":"EUR",
      "amount":"0"
    },
    "value":{
      "currency":"EUR",
      "amount":"0"
    }
  },
  "metadata":{
    "narrative":"NONE",
    "comments":[{
      "id":"5995d6a2-01b3-423c-a173-5481df49bdaf",
      "value":"OBP",
      "date":"1100-01-01T00:00:00Z",
      "user":{
        "id":"5995d6a2-01b3-423c-a173-5481df49bdaf",
        "provider":"http://127.0.0.1:8080",
        "display_name":"OBP"
      }
    }],
    "tags":[{
      "id":"5995d6a2-01b3-423c-a173-5481df49bdaf",
      "value":"OBP",
      "date":"1100-01-01T00:00:00Z",
      "user":{
        "id":"5995d6a2-01b3-423c-a173-5481df49bdaf",
        "provider":"http://127.0.0.1:8080",
        "display_name":"OBP"
      }
    }],
    "images":[{
      "id":"5995d6a2-01b3-423c-a173-5481df49bdaf",
      "label":"NONE",
      "URL":"www.openbankproject.com",
      "date":"1100-01-01T00:00:00Z",
      "user":{
        "id":"5995d6a2-01b3-423c-a173-5481df49bdaf",
        "provider":"http://127.0.0.1:8080",
        "display_name":"OBP"
      }
    }],
    "where":{
      "latitude":1.231,
      "longitude":1.231,
      "date":"1100-01-01T00:00:00Z",
      "user":{
        "id":"5995d6a2-01b3-423c-a173-5481df49bdaf",
        "provider":"http://127.0.0.1:8080",
        "display_name":"OBP"
      }
    }
  },
  "transaction_attributes":[{
    "transaction_attribute_id":"7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh",
    "name":"HOUSE_RENT",
    "type":"DATE_WITH_DAY",
    "value":"123456789"
  }]
}
Validations:
  • Required JSON Validation: No
  • Allowed Authentication Types: Not set
Possible Errors:
  • OBP-30018: Bank Account not found. Please specify valid values for BANK_ID and ACCOUNT_ID.
  • OBP-30005: View not found for Account. Please specify a valid value for VIEW_ID
  • OBP-20017: Current user does not have access to the view. Please specify a valid value for VIEW_ID.
  • OBP-50000: Unknown Error.
Connector Methods:
Version: OBPv3.1.0, function_name: by getTransactionByIdForBankAccount, operation_id: OBPv3.1.0-getTransactionByIdForBankAccount Tags: Transaction,

Get Transactions for Account (Core)

Returns transactions list (Core info) of the account specified by ACCOUNT_ID.

Authentication is Mandatory

Possible custom url parameters for pagination:

  • limit=NUMBER ==> default value: 50
  • offset=NUMBER ==> default value: 0

eg1:?limit=100&offset=0

  • sort_direction=ASC/DESC ==> default value: DESC.

eg2:?limit=100&offset=0&sort_direction=ASC

  • from_date=DATE => example value: 1970-01-01T00:00:00.000Z. NOTE! The default value is one year ago (1970-01-01T00:00:00.000Z).
  • to_date=DATE => example value: 2024-11-20T21:32:27.694Z. NOTE! The default value is now (2024-11-20T21:32:27.694Z).

Date format parameter: yyyy-MM-dd'T'HH:mm:ss.SSS'Z'(1100-01-01T01:01:01.000Z) ==> time zone is UTC.

eg3:?sort_direction=ASC&limit=100&offset=0&from_date=1100-01-01T01:01:01.000Z&to_date=1100-01-01T01:01:01.000Z

URL Parameters:

ACCOUNT_ID: 8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0

BANK_ID: gh.29.uk

JSON response body fields:

account_routings:

address:

amount: 10.12

bank_routing:

completed: 2020-01-27

currency: EUR

description: Description of the object. Maximum length is 2000. It can be any characters here.

details:

holder:

holders:

id: d8839721-ad8f-45dd-9f78-2080414b93f9

is_alias:

name: ACCOUNT_MANAGEMENT_FEE

new_balance: 20

other_account:

posted: 2020-01-27

scheme: scheme value

this_account:

transaction_attribute_id: 7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh

transaction_attributes:

transactions:

type:

value: 5987953

Typical Successful Response: 

								
									
{
  "transactions":[{
    "id":"5995d6a2-01b3-423c-a173-5481df49bdaf",
    "this_account":{
      "id":"String",
      "bank_routing":{
        "scheme":"scheme value",
        "address":""
      },
      "account_routings":[{
        "scheme":"AccountNumber",
        "address":"4930396"
      }],
      "holders":[{
        "name":"OBP",
        "is_alias":true
      }]
    },
    "other_account":{
      "id":"5995d6a2-01b3-423c-a173-5481df49bdaf",
      "holder":{
        "name":"OBP",
        "is_alias":true
      },
      "bank_routing":{
        "scheme":"scheme value",
        "address":""
      },
      "account_routings":[{
        "scheme":"AccountNumber",
        "address":"4930396"
      }]
    },
    "details":{
      "type":"AC",
      "description":"OBP",
      "posted":"1100-01-01T00:00:00Z",
      "completed":"1100-01-01T00:00:00Z",
      "new_balance":{
        "currency":"EUR",
        "amount":"0"
      },
      "value":{
        "currency":"EUR",
        "amount":"0"
      }
    },
    "transaction_attributes":[{
      "transaction_attribute_id":"7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh",
      "name":"HOUSE_RENT",
      "type":"DATE_WITH_DAY",
      "value":"123456789"
    }]
  }]
}
Validations:
  • Required JSON Validation: No
  • Allowed Authentication Types: Not set
Possible Errors:
  • OBP-10023: obp_sort_direction parameter can only take two values: DESC or ASC!
  • OBP-10024: wrong value for obp_offset parameter. Please send a positive integer (=>0)!
  • OBP-10025: wrong value for obp_limit parameter. Please send a positive integer (=>1)!
  • OBP-10026: Failed to parse date string. Please use this format yyyy-MM-dd'T'HH:mm:ss.SSS'Z'!
  • OBP-20001: User not logged in. Authentication is required!
  • OBP-30018: Bank Account not found. Please specify valid values for BANK_ID and ACCOUNT_ID.
  • OBP-30005: View not found for Account. Please specify a valid value for VIEW_ID
  • OBP-50000: Unknown Error.
Connector Methods:
Version: OBPv3.0.0, function_name: by getCoreTransactionsForBankAccount, operation_id: OBPv3.0.0-getCoreTransactionsForBankAccount Tags: Transaction, Account Information Service (AIS), Account, PSD2,

Get Transactions for Account (Full)

Returns transactions list of the account specified by ACCOUNT_ID and moderated by the view (VIEW_ID).

Authentication is Optional

Authentication is required if the view is not public.

Possible custom url parameters for pagination:

  • limit=NUMBER ==> default value: 50
  • offset=NUMBER ==> default value: 0

eg1:?limit=100&offset=0

  • sort_direction=ASC/DESC ==> default value: DESC.

eg2:?limit=100&offset=0&sort_direction=ASC

  • from_date=DATE => example value: 1970-01-01T00:00:00.000Z. NOTE! The default value is one year ago (1970-01-01T00:00:00.000Z).
  • to_date=DATE => example value: 2024-11-20T21:32:27.695Z. NOTE! The default value is now (2024-11-20T21:32:27.695Z).

Date format parameter: yyyy-MM-dd'T'HH:mm:ss.SSS'Z'(1100-01-01T01:01:01.000Z) ==> time zone is UTC.

eg3:?sort_direction=ASC&limit=100&offset=0&from_date=1100-01-01T01:01:01.000Z&to_date=1100-01-01T01:01:01.000Z

URL Parameters:

ACCOUNT_ID: 8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0

BANK_ID: gh.29.uk

VIEW_ID: owner

JSON response body fields:

URL: http://www.example.com/id-docs/123/image.png

account_routings:

address:

amount: 10.12

bank_routing:

comments:

completed: 2020-01-27

corporate_location: 10

currency: EUR

date: 2020-01-27

description: Description of the object. Maximum length is 2000. It can be any characters here.

details:

display_name:

holder:

holders:

id: d8839721-ad8f-45dd-9f78-2080414b93f9

image_URL:

images:

is_alias:

label: My Account

latitude: 38.8951

longitude: -77.0364

metadata:

more_info: More information about this fee

name: ACCOUNT_MANAGEMENT_FEE

narrative:

new_balance: 20

open_corporates_URL:

other_account:

physical_location:

posted: 2020-01-27

private_alias:

provider: ETHEREUM

public_alias:

scheme: scheme value

tags: Create-My-User

this_account:

transaction_attribute_id: 7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh

transaction_attributes:

transactions:

type:

user:

value: 5987953

where:

Typical Successful Response: 

								
									
{
  "transactions":[{
    "id":"String",
    "this_account":{
      "id":"String",
      "bank_routing":{
        "scheme":"scheme value",
        "address":""
      },
      "account_routings":[{
        "scheme":"AccountNumber",
        "address":"4930396"
      }],
      "holders":[{
        "name":"OBP",
        "is_alias":true
      }]
    },
    "other_account":{
      "id":"5995d6a2-01b3-423c-a173-5481df49bdaf",
      "holder":{
        "name":"OBP",
        "is_alias":true
      },
      "bank_routing":{
        "scheme":"scheme value",
        "address":""
      },
      "account_routings":[{
        "scheme":"AccountNumber",
        "address":"4930396"
      }],
      "metadata":{
        "public_alias":"NONE",
        "private_alias":"NONE",
        "more_info":"www.openbankproject.com",
        "URL":"www.openbankproject.com",
        "image_URL":"www.openbankproject.com",
        "open_corporates_URL":"www.openbankproject.com",
        "corporate_location":{
          "latitude":1.231,
          "longitude":1.231,
          "date":"1100-01-01T00:00:00Z",
          "user":{
            "id":"5995d6a2-01b3-423c-a173-5481df49bdaf",
            "provider":"http://127.0.0.1:8080",
            "display_name":"OBP"
          }
        },
        "physical_location":{
          "latitude":1.231,
          "longitude":1.231,
          "date":"1100-01-01T00:00:00Z",
          "user":{
            "id":"5995d6a2-01b3-423c-a173-5481df49bdaf",
            "provider":"http://127.0.0.1:8080",
            "display_name":"OBP"
          }
        }
      }
    },
    "details":{
      "type":"AC",
      "description":"this is for family",
      "posted":"1100-01-01T00:00:00Z",
      "completed":"1100-01-01T00:00:00Z",
      "new_balance":{
        "currency":"EUR",
        "amount":"0"
      },
      "value":{
        "currency":"EUR",
        "amount":"0"
      }
    },
    "metadata":{
      "narrative":"NONE",
      "comments":[{
        "id":"5995d6a2-01b3-423c-a173-5481df49bdaf",
        "value":"OBP",
        "date":"1100-01-01T00:00:00Z",
        "user":{
          "id":"5995d6a2-01b3-423c-a173-5481df49bdaf",
          "provider":"http://127.0.0.1:8080",
          "display_name":"OBP"
        }
      }],
      "tags":[{
        "id":"5995d6a2-01b3-423c-a173-5481df49bdaf",
        "value":"OBP",
        "date":"1100-01-01T00:00:00Z",
        "user":{
          "id":"5995d6a2-01b3-423c-a173-5481df49bdaf",
          "provider":"http://127.0.0.1:8080",
          "display_name":"OBP"
        }
      }],
      "images":[{
        "id":"5995d6a2-01b3-423c-a173-5481df49bdaf",
        "label":"NONE",
        "URL":"www.openbankproject.com",
        "date":"1100-01-01T00:00:00Z",
        "user":{
          "id":"5995d6a2-01b3-423c-a173-5481df49bdaf",
          "provider":"http://127.0.0.1:8080",
          "display_name":"OBP"
        }
      }],
      "where":{
        "latitude":1.231,
        "longitude":1.231,
        "date":"1100-01-01T00:00:00Z",
        "user":{
          "id":"5995d6a2-01b3-423c-a173-5481df49bdaf",
          "provider":"http://127.0.0.1:8080",
          "display_name":"OBP"
        }
      }
    },
    "transaction_attributes":[{
      "transaction_attribute_id":"7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh",
      "name":"HOUSE_RENT",
      "type":"DATE_WITH_DAY",
      "value":"123456789"
    }]
  }]
}
Validations:
  • Required JSON Validation: No
  • Allowed Authentication Types: Not set
Possible Errors:
  • OBP-10023: obp_sort_direction parameter can only take two values: DESC or ASC!
  • OBP-10024: wrong value for obp_offset parameter. Please send a positive integer (=>0)!
  • OBP-10025: wrong value for obp_limit parameter. Please send a positive integer (=>1)!
  • OBP-10026: Failed to parse date string. Please use this format yyyy-MM-dd'T'HH:mm:ss.SSS'Z'!
  • OBP-30018: Bank Account not found. Please specify valid values for BANK_ID and ACCOUNT_ID.
  • OBP-30005: View not found for Account. Please specify a valid value for VIEW_ID
  • OBP-50000: Unknown Error.
Connector Methods:
Version: OBPv3.0.0, function_name: by getTransactionsForBankAccount, operation_id: OBPv3.0.0-getTransactionsForBankAccount Tags: Transaction, Account,

Update Transaction Attribute

Update Transaction Attribute

Authentication is Mandatory

URL Parameters:

ACCOUNT_ATTRIBUTE_ID:

ACCOUNT_ID: 8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0

BANK_ID: gh.29.uk

TRANSACTION_ID: 2fg8a7e4-6d02-40e3-a129-0b2bf89de8ub

JSON response body fields:

name: ACCOUNT_MANAGEMENT_FEE

transaction_attribute_id: 7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh

type:

value: 5987953

Typical Successful Response: 

								
									
{
  "transaction_attribute_id":"7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh",
  "name":"HOUSE_RENT",
  "type":"DATE_WITH_DAY",
  "value":"123456789"
}
Required Roles:
  • CanUpdateTransactionAttributeAtOneBank - Please login to request this Role
Validations:
  • Required JSON Validation: No
  • Allowed Authentication Types: Not set
Possible Errors:
  • OBP-20001: User not logged in. Authentication is required!
  • OBP-30001: Bank not found. Please specify a valid value for BANK_ID.
  • OBP-30018: Bank Account not found. Please specify valid values for BANK_ID and ACCOUNT_ID.
  • OBP-10001: Incorrect json format.
  • OBP-50000: Unknown Error.
  • OBP-20006: User is missing one or more roles:
Connector Methods:
Version: OBPv4.0.0, function_name: by updateTransactionAttribute, operation_id: OBPv4.0.0-updateTransactionAttribute Tags: Transaction,