API Explorer

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

Respuesta Exitosa Típica:

								
									{
  "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
}

Request Headers:

Response Headers:

Roles Requeridos:

CanCreateTransactionAttributeDefinitionAtOneBank - Please login to request this Role

Validaciones:

Required JSON Validation: No
Allowed Authentication Types: Not set

Posibles Errores:

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:

Métodos de conector::

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:

Respuesta Exitosa Típica:

Request Headers:

Response Headers:

Roles Requeridos:

CanDeleteTransactionAttributeDefinitionAtOneBank - Please login to request this Role

Validaciones:

Required JSON Validation: No
Allowed Authentication Types: Not set

Posibles Errores:

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:

Métodos de conector::

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:

Respuesta Exitosa Típica:

Request Headers:

Response Headers:

Roles Requeridos:

CanDeleteTransactionCascade - Please login to request this Role

Validaciones:

Required JSON Validation: No
Allowed Authentication Types: Not set

Posibles Errores:

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.

Métodos de conector::

Version: OBPv4.0.0, function_name: by deleteTransactionCascade, operation_id: OBPv4.0.0-deleteTransactionCascade Tags: 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

Respuesta Exitosa Típica:

								
									{
  "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"
  }
}

Request Headers:

Response Headers:

Roles Requeridos:

Validaciones:

Required JSON Validation: No
Allowed Authentication Types: Not set

Posibles Errores:

OBP-20001: User not logged in. Authentication is required!
OBP-10001: Incorrect json format.
OBP-50000: Unknown Error.

Métodos de conector::

Version: OBPv4.0.0, function_name: by getBalancingTransaction, operation_id: OBPv4.0.0-getBalancingTransaction Tags: 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

Respuesta Exitosa Típica:

								
									{
  "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"
  }
}

Request Headers:

Response Headers:

Roles Requeridos:

CanGetDoubleEntryTransactionAtAnyBank - Please login to request this Role
CanGetDoubleEntryTransactionAtOneBank - Please login to request this Role

Validaciones:

Required JSON Validation: No
Allowed Authentication Types: Not set

Posibles Errores:

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:

Métodos de conector::

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: 500
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-03-13T11:39:35.710Z. NOTE! The default value is now (2024-03-13T11:39:35.711Z).

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:

amount: 10.12

completed: 2020-01-27

date: 2020-01-27

description: This an optional field. Maximum length is 2000. It can be any characters here.

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

label: My Account

latitude: 38.8951

longitude: -77.0364

more_info: More information about this fee

name: ACCOUNT_MANAGEMENT_FEE

posted: 2020-01-27

provider: ETHEREUM

scheme: scheme value

tags: Create-My-User

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

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

value: 5987953

Respuesta Exitosa Típica:

								
									{
  "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"
    }]
  }]
}

Request Headers:

Response Headers:

Roles Requeridos:

CanUseAccountFirehoseAtAnyBank - Please login to request this Role
CanUseAccountFirehose - Please login to request this Role

Validaciones:

Required JSON Validation: No
Allowed Authentication Types: Not set

Posibles Errores:

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.

Métodos de conector::

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

bank:

date: 2020-01-27

holder:

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

kind:

latitude: 38.8951

longitude: -77.0364

more_info: More information about this fee

name: ACCOUNT_MANAGEMENT_FEE

national_identifier:

number:

provider: ETHEREUM

swift_bic:

Respuesta Exitosa Típica:

								
									{
  "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"
      }
    }
  }
}

Request Headers:

Response Headers:

Roles Requeridos:

Validaciones:

Required JSON Validation: No
Allowed Authentication Types: Not set

Posibles Errores:

OBP-30018: Bank Account not found. Please specify valid values for BANK_ID and ACCOUNT_ID.
OBP-50000: Unknown Error.

Métodos de conector::

Version: OBPv1.2.1, function_name: by getOtherAccountForTransaction, operation_id: OBPv1.2.1-getOtherAccountForTransaction Tags: Transaction, Counterparty,

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

attribute_definition_id:

value: 5987953

Respuesta Exitosa Típica:

								
									{
  "transaction_attribute_id":"7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh",
  "name":"HOUSE_RENT",
  "type":"DATE_WITH_DAY",
  "value":"123456789"
}

Request Headers:

Response Headers:

Roles Requeridos:

CanGetTransactionAttributeAtOneBank - Please login to request this Role

Validaciones:

Required JSON Validation: No
Allowed Authentication Types: Not set

Posibles Errores:

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:

Métodos de conector::

Version: OBPv4.0.0, function_name: by getTransactionAttributeById, operation_id: OBPv4.0.0-getTransactionAttributeById Tags: Transaction,

Get Transaction Attribute Definition

Authentication is Mandatory

URL Parameters:

BANK_ID: gh.29.uk

JSON response body fields:

alias:

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

bank_id: gh.29.uk

can_be_seen_on_views: true

category:

description: This an optional field. Maximum length is 2000. It can be any characters here.

is_active: true

name: ACCOUNT_MANAGEMENT_FEE

Respuesta Exitosa Típica:

								
									{
  "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
  }]
}

Request Headers:

Response Headers:

Roles Requeridos:

CanGetTransactionAttributeDefinitionAtOneBank - Please login to request this Role

Validaciones:

Required JSON Validation: No
Allowed Authentication Types: Not set

Posibles Errores:

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:

Métodos de conector::

Version: OBPv4.0.0, function_name: by getTransactionAttributeDefinition, operation_id: OBPv4.0.0-getTransactionAttributeDefinition Tags: Transaction,

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

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

value: 5987953

Respuesta Exitosa Típica:

								
									{
  "transaction_attributes":[{
    "transaction_attribute_id":"7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh",
    "name":"HOUSE_RENT",
    "type":"DATE_WITH_DAY",
    "value":"123456789"
  }]
}

Request Headers:

Response Headers:

Roles Requeridos:

CanGetTransactionAttributesAtOneBank - Please login to request this Role

Validaciones:

Required JSON Validation: No
Allowed Authentication Types: Not set

Posibles Errores:

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:

Métodos de conector::

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:

amount: 10.12

completed: 2020-01-27

date: 2020-01-27

description: This an optional field. Maximum length is 2000. It can be any characters here.

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

label: My Account

latitude: 38.8951

longitude: -77.0364

more_info: More information about this fee

name: ACCOUNT_MANAGEMENT_FEE

posted: 2020-01-27

provider: ETHEREUM

scheme: scheme value

tags: Create-My-User

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

value: 5987953

where:

Respuesta Exitosa Típica:

								
									{
  "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"
  }]
}

Request Headers:

Response Headers:

Roles Requeridos:

Validaciones:

Required JSON Validation: No
Allowed Authentication Types: Not set

Posibles Errores:

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.

Métodos de conector::

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: 500
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-03-13T11:39:35.711Z. NOTE! The default value is now (2024-03-13T11:39:35.711Z).

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:

amount: 10.12

completed: 2020-01-27

description: This an optional field. Maximum length is 2000. It can be any characters here.

details:

holder:

holders:

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

name: ACCOUNT_MANAGEMENT_FEE

posted: 2020-01-27

scheme: scheme value

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

transactions:

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

value: 5987953

Respuesta Exitosa Típica:

								
									{
  "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"
    }]
  }]
}

Request Headers:

Response Headers:

Roles Requeridos:

Validaciones:

Required JSON Validation: No
Allowed Authentication Types: Not set

Posibles Errores:

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.

Métodos de conector::

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: 500
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-03-13T11:39:35.711Z. NOTE! The default value is now (2024-03-13T11:39:35.711Z).

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:

amount: 10.12

completed: 2020-01-27

date: 2020-01-27

description: This an optional field. Maximum length is 2000. It can be any characters here.

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

label: My Account

latitude: 38.8951

longitude: -77.0364

more_info: More information about this fee

name: ACCOUNT_MANAGEMENT_FEE

posted: 2020-01-27

provider: ETHEREUM

scheme: scheme value

tags: Create-My-User

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

value: 5987953

Respuesta Exitosa Típica:

								
									{
  "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"
    }]
  }]
}

Request Headers:

Response Headers:

Roles Requeridos:

Validaciones:

Required JSON Validation: No
Allowed Authentication Types: Not set

Posibles Errores:

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.

Métodos de conector::

Version: OBPv3.0.0, function_name: by getTransactionsForBankAccount, operation_id: OBPv3.0.0-getTransactionsForBankAccount Tags: Transaction, Account,

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

value: 5987953

Respuesta Exitosa Típica:

								
									{
  "transaction_attribute_id":"7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh",
  "name":"HOUSE_RENT",
  "type":"DATE_WITH_DAY",
  "value":"123456789"
}

Request Headers:

Response Headers:

Roles Requeridos:

CanUpdateTransactionAttributeAtOneBank - Please login to request this Role

Validaciones:

Required JSON Validation: No
Allowed Authentication Types: Not set

Posibles Errores:

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:

Métodos de conector::

Version: OBPv4.0.0, function_name: by updateTransactionAttribute, operation_id: OBPv4.0.0-updateTransactionAttribute Tags: Transaction,

Add a Transaction Comment

Posts a comment about a transaction TRANSACTION_ID on a view VIEW_ID.

${authenticationRequiredMessage(false)}

Authentication is required since the comment is linked with the user.

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 request body fields:

value: 5987953

JSON response body fields:

date: 2020-01-27

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

provider: ETHEREUM

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

value: 5987953

Respuesta Exitosa Típica:

								
									{
  "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"
  }
}

Request Headers:

Response Headers:

Roles Requeridos:

Validaciones:

Required JSON Validation: No
Allowed Authentication Types: Not set

Posibles Errores:

OBP-20001: User not logged in. Authentication is required!
OBP-10001: Incorrect json format.
OBP-30018: Bank Account not found. Please specify valid values for BANK_ID and ACCOUNT_ID.
OBP-30022: The current view does not have the permission:
OBP-30005: View not found for Account. Please specify a valid value for VIEW_ID
OBP-50000: Unknown Error.

Métodos de conector::

Version: OBPv1.2.1, function_name: by addCommentForViewOnTransaction, operation_id: OBPv1.2.1-addCommentForViewOnTransaction Tags: Transaction-Metadata, Transaction,

Add a Transaction Image

Posts an image about a transaction TRANSACTION_ID on a view VIEW_ID.

Authentication is Mandatory

The image is linked with the user.

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 request body fields:

label: My Account

JSON response body fields:

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

date: 2020-01-27

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

label: My Account

provider: ETHEREUM

Respuesta Exitosa Típica:

								
									{
  "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"
  }
}

Request Headers:

Response Headers:

Roles Requeridos:

Validaciones:

Required JSON Validation: No
Allowed Authentication Types: Not set

Posibles Errores:

OBP-10001: Incorrect json format.
OBP-30018: Bank Account not found. Please specify valid values for BANK_ID and ACCOUNT_ID.
OBP-30022: The current view does not have the permission:
OBP-30005: View not found for Account. Please specify a valid value for VIEW_ID
OBP-10017: Incorrect URL Format.
OBP-50000: Unknown Error.
OBP-20001: User not logged in. Authentication is required!

Métodos de conector::

Version: OBPv1.2.1, function_name: by addImageForViewOnTransaction, operation_id: OBPv1.2.1-addImageForViewOnTransaction Tags: Transaction-Metadata, Transaction,

Add a Transaction Narrative

Creates a description of the transaction TRANSACTION_ID.

Note: Unlike other items of metadata, there is only one "narrative" per transaction accross all views.
If you set narrative via a view e.g. view-x it will be seen via view-y (as long as view-y has permission to see the narrative).

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 request body fields:

JSON response body fields:

Respuesta Exitosa Típica:

								
									{
  "success":"Success"
}

Request Headers:

Response Headers:

Roles Requeridos:

Validaciones:

Required JSON Validation: No
Allowed Authentication Types: Not set

Posibles Errores:

OBP-10001: Incorrect json format.
OBP-30018: Bank Account not found. Please specify valid values for BANK_ID and ACCOUNT_ID.
OBP-30022: The current view does not have the permission:
OBP-30005: View not found for Account. Please specify a valid value for VIEW_ID
OBP-50000: Unknown Error.

Métodos de conector::

Version: OBPv1.2.1, function_name: by addTransactionNarrative, operation_id: OBPv1.2.1-addTransactionNarrative Tags: Transaction-Metadata, Transaction,

Add a Transaction Tag

Posts a tag about a transaction TRANSACTION_ID on a view VIEW_ID.

Authentication is Mandatory

Authentication is required as the tag is linked with the user.

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 request body fields:

value: 5987953

JSON response body fields:

date: 2020-01-27

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

provider: ETHEREUM

value: 5987953

Respuesta Exitosa Típica:

								
									{
  "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"
  }
}

Request Headers:

Response Headers:

Roles Requeridos:

Validaciones:

Required JSON Validation: No
Allowed Authentication Types: Not set

Posibles Errores:

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-10001: Incorrect json format.
OBP-30022: The current view does not have the permission:
OBP-30005: View not found for Account. Please specify a valid value for VIEW_ID
OBP-50000: Unknown Error.

Métodos de conector::

Version: OBPv1.2.1, function_name: by addTagForViewOnTransaction, operation_id: OBPv1.2.1-addTagForViewOnTransaction Tags: Transaction-Metadata, Transaction,

Add a Transaction where Tag

Creates a "where" Geo tag on a transaction TRANSACTION_ID in a view.

Authentication is Mandatory

The geo tag is linked with the user.

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 request body fields:

latitude: 38.8951

longitude: -77.0364

where:

JSON response body fields:

Respuesta Exitosa Típica:

								
									{
  "success":"Success"
}

Request Headers:

Response Headers:

Roles Requeridos:

Validaciones:

Required JSON Validation: No
Allowed Authentication Types: Not set

Posibles Errores:

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-10001: Incorrect json format.
OBP-30005: View not found for Account. Please specify a valid value for VIEW_ID
OBP-30022: The current view does not have the permission:
Coordinates not possible
OBP-50000: Unknown Error.

Métodos de conector::

Version: OBPv1.2.1, function_name: by addWhereTagForViewOnTransaction, operation_id: OBPv1.2.1-addWhereTagForViewOnTransaction Tags: Transaction-Metadata, Transaction,

Delete a Transaction Comment

Delete the comment COMMENT_ID about the transaction TRANSACTION_ID made on view.

Authentication via OAuth is required. The user must either have owner privileges for this account, or must be the user that posted the comment.

Authentication is Mandatory

URL Parameters:

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

BANK_ID: gh.29.uk

COMMENT_ID:

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

VIEW_ID: owner

JSON response body fields:

Respuesta Exitosa Típica:

								
									{
  "jsonString":"{}"
}

Request Headers:

Response Headers:

Roles Requeridos:

Validaciones:

Required JSON Validation: No
Allowed Authentication Types: Not set

Posibles Errores:

OBP-30018: Bank Account not found. Please specify valid values for BANK_ID and ACCOUNT_ID.
OBP-30022: The current view does not have the permission:
OBP-30005: View not found for Account. Please specify a valid value for VIEW_ID
OBP-20001: User not logged in. Authentication is required!
OBP-50000: Unknown Error.

Métodos de conector::

Version: OBPv1.2.1, function_name: by deleteCommentForViewOnTransaction, operation_id: OBPv1.2.1-deleteCommentForViewOnTransaction Tags: Transaction-Metadata, Transaction,

Delete a Transaction Image

Deletes the image IMAGE_ID about the transaction TRANSACTION_ID made on view.

Authentication via OAuth is required. The user must either have owner privileges for this account, or must be the user that posted the image.

Authentication is Mandatory

URL Parameters:

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

BANK_ID: gh.29.uk

IMAGE_ID:

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

VIEW_ID: owner

JSON response body fields:

Respuesta Exitosa Típica:

								
									{
  "jsonString":"{}"
}

Request Headers:

Response Headers:

Roles Requeridos:

Validaciones:

Required JSON Validation: No
Allowed Authentication Types: Not set

Posibles Errores:

OBP-30018: Bank Account not found. Please specify valid values for BANK_ID and ACCOUNT_ID.
OBP-30022: The current view does not have the permission:
OBP-20001: User not logged in. Authentication is required!
You must be able to see images in order to delete them
Image not found for this transaction
Deleting images not permitted for this view
Deleting images not permitted for the current user
OBP-50000: Unknown Error.

Métodos de conector::

Version: OBPv1.2.1, function_name: by deleteImageForViewOnTransaction, operation_id: OBPv1.2.1-deleteImageForViewOnTransaction Tags: Transaction-Metadata, Transaction,

Delete a Transaction Narrative

Deletes the description of the transaction TRANSACTION_ID.

Authentication via OAuth is required if the view is not public.

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:

Respuesta Exitosa Típica:

								
									{
  "jsonString":"{}"
}

Request Headers:

Response Headers:

Roles Requeridos:

Validaciones:

Required JSON Validation: No
Allowed Authentication Types: Not set

Posibles Errores:

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-30022: The current view does not have the permission:
OBP-50000: Unknown Error.

Métodos de conector::

Version: OBPv1.2.1, function_name: by deleteTransactionNarrative, operation_id: OBPv1.2.1-deleteTransactionNarrative Tags: Transaction-Metadata, Transaction,

Delete a Transaction Tag

Deletes the tag TAG_ID about the transaction TRANSACTION_ID made on view.
Authentication via OAuth is required. The user must either have owner privileges for this account,
or must be the user that posted the tag.

Authentication is Optional

URL Parameters:

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

BANK_ID: gh.29.uk

TAG_ID:

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

VIEW_ID: owner

JSON response body fields:

Respuesta Exitosa Típica:

								
									{
  "jsonString":"{}"
}

Request Headers:

Response Headers:

Roles Requeridos:

Validaciones:

Required JSON Validation: No
Allowed Authentication Types: Not set

Posibles Errores:

OBP-30022: The current view does not have the permission:
OBP-30005: View not found for Account. Please specify a valid value for VIEW_ID
OBP-50000: Unknown Error.

Métodos de conector::

Version: OBPv1.2.1, function_name: by deleteTagForViewOnTransaction, operation_id: OBPv1.2.1-deleteTagForViewOnTransaction Tags: Transaction-Metadata, Transaction,

Delete a Transaction Tag

Deletes the where tag of the transaction TRANSACTION_ID made on view.

Authentication is Mandatory

The user must either have owner privileges for this account, or must be the user that posted the geo tag.

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:

Respuesta Exitosa Típica:

								
									{
  "jsonString":"{}"
}

Request Headers:

Response Headers:

Roles Requeridos:

Validaciones:

Required JSON Validation: No
Allowed Authentication Types: Not set

Posibles Errores:

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-30022: The current view does not have the permission:
OBP-20001: User not logged in. Authentication is required!
OBP-30005: View not found for Account. Please specify a valid value for VIEW_ID
there is no tag to delete
Delete not completed
OBP-50000: Unknown Error.

Métodos de conector::

Version: OBPv1.2.1, function_name: by deleteWhereTagForViewOnTransaction, operation_id: OBPv1.2.1-deleteWhereTagForViewOnTransaction Tags: Transaction-Metadata, Transaction,

Get Transaction Comments

Returns the transaction TRANSACTION_ID comments made on a view (VIEW_ID).

Authentication via OAuth is required if the view is not public.

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:

date: 2020-01-27

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

provider: ETHEREUM

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

value: 5987953

Respuesta Exitosa Típica:

								
									{
  "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"
    }
  }]
}

Request Headers:

Response Headers:

Roles Requeridos:

Validaciones:

Required JSON Validation: No
Allowed Authentication Types: Not set

Posibles Errores:

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-30022: The current view does not have the permission:
OBP-30005: View not found for Account. Please specify a valid value for VIEW_ID
OBP-50000: Unknown Error.

Métodos de conector::

Version: OBPv1.2.1, function_name: by getCommentsForViewOnTransaction, operation_id: OBPv1.2.1-getCommentsForViewOnTransaction Tags: Transaction-Metadata, Transaction,

Get Transaction Images

Returns the transaction TRANSACTION_ID images made on a view (VIEW_ID).
Authentication via OAuth is required if the view is not public.

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:

date: 2020-01-27

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

label: My Account

provider: ETHEREUM

Respuesta Exitosa Típica:

								
									{
  "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"
    }
  }]
}

Request Headers:

Response Headers:

Roles Requeridos:

Validaciones:

Required JSON Validation: No
Allowed Authentication Types: Not set

Posibles Errores:

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-30022: The current view does not have the permission:
OBP-30005: View not found for Account. Please specify a valid value for VIEW_ID
OBP-50000: Unknown Error.

Métodos de conector::

Version: OBPv1.2.1, function_name: by getImagesForViewOnTransaction, operation_id: OBPv1.2.1-getImagesForViewOnTransaction Tags: Transaction-Metadata, Transaction,

Get Transaction Tags

Returns the transaction TRANSACTION_ID tags made on a 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:

date: 2020-01-27

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

provider: ETHEREUM

value: 5987953

Respuesta Exitosa Típica:

								
									{
  "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"
  }
}

Request Headers:

Response Headers:

Roles Requeridos:

Validaciones:

Required JSON Validation: No
Allowed Authentication Types: Not set

Posibles Errores:

OBP-30018: Bank Account not found. Please specify valid values for BANK_ID and ACCOUNT_ID.
OBP-30022: The current view does not have the permission:
OBP-30005: View not found for Account. Please specify a valid value for VIEW_ID
OBP-50000: Unknown Error.

Métodos de conector::

Version: OBPv1.2.1, function_name: by getTagsForViewOnTransaction, operation_id: OBPv1.2.1-getTagsForViewOnTransaction Tags: Transaction-Metadata, Transaction,

Get a Transaction Narrative

Returns the account owner description of the transaction moderated by the view.

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:

Respuesta Exitosa Típica:

								
									{
  "narrative":"narative"
}

Request Headers:

Response Headers:

Roles Requeridos:

Validaciones:

Required JSON Validation: No
Allowed Authentication Types: Not set

Posibles Errores:

OBP-30018: Bank Account not found. Please specify valid values for BANK_ID and ACCOUNT_ID.
OBP-30022: The current view does not have the permission:
OBP-30005: View not found for Account. Please specify a valid value for VIEW_ID
OBP-50000: Unknown Error.

Métodos de conector::

Version: OBPv1.2.1, function_name: by getTransactionNarrative, operation_id: OBPv1.2.1-getTransactionNarrative Tags: Transaction-Metadata, Transaction,

Get a Transaction where Tag

Returns the "where" Geo tag added to the transaction TRANSACTION_ID made on a view (VIEW_ID).
It represents the location where the transaction has been initiated.

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:

date: 2020-01-27

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

latitude: 38.8951

longitude: -77.0364

provider: ETHEREUM

where:

Respuesta Exitosa Típica:

								
									{
  "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"
    }
  }
}

Request Headers:

Response Headers:

Roles Requeridos:

Validaciones:

Required JSON Validation: No
Allowed Authentication Types: Not set

Posibles Errores:

OBP-30018: Bank Account not found. Please specify valid values for BANK_ID and ACCOUNT_ID.
OBP-30022: The current view does not have the permission:
OBP-30005: View not found for Account. Please specify a valid value for VIEW_ID
OBP-50000: Unknown Error.

Métodos de conector::

Version: OBPv1.2.1, function_name: by getWhereTagForViewOnTransaction, operation_id: OBPv1.2.1-getWhereTagForViewOnTransaction Tags: Transaction-Metadata, Transaction,

Update a Transaction Narrative

Updates the description of the transaction TRANSACTION_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:

Respuesta Exitosa Típica:

								
									{
  "success":"Success"
}

Request Headers:

Response Headers:

Roles Requeridos:

Validaciones:

Required JSON Validation: No
Allowed Authentication Types: Not set

Posibles Errores:

OBP-10001: Incorrect json format.
OBP-30018: Bank Account not found. Please specify valid values for BANK_ID and ACCOUNT_ID.
OBP-30022: The current view does not have the permission:
OBP-30005: View not found for Account. Please specify a valid value for VIEW_ID
OBP-50000: Unknown Error.

Métodos de conector::

Version: OBPv1.2.1, function_name: by updateTransactionNarrative, operation_id: OBPv1.2.1-updateTransactionNarrative Tags: Transaction-Metadata, Transaction,

Update a Transaction where Tag

Updates the "where" Geo tag on a transaction TRANSACTION_ID in a view.

Authentication is Mandatory

The geo tag is linked with the user.

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: