right logo image
right logo image
Ingresar
⯆

API Explorer

Log off

v3.0.0 (165 APIs)

Anfitrión de la API: https://api3.openbankproject.com
Banco
Cuentas
Vistas
Contrapartes
Transacciones

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: 2022-05-29T00:00:43.117Z. NOTE! The default value is one year ago (2022-05-29T00:00:43.118Z).
  • to_date=DATE => example value: 2023-05-29T00:00:43.118Z. NOTE! The default value is now (2023-05-29T00:00:43.118Z).

Date format parameter: yyyy-MM-dd'T'HH:mm:ss.SSS'Z'(2017-09-19T02:31:05.000Z) ==> time zone is UTC.

eg3:?sort_direction=ASC&limit=100&offset=0&from_date=2017-09-19T02:31:05.000Z&to_date=2017-09-19T02:31:05.000Z

Authentication is Mandatory

URL Parameters:

JSON response body fields:

Respuesta Exitosa Típica: 

								
									
{
  "transactions":[{
    "id":"String",
    "this_account":{
      "id":"String",
      "bank_routing":{
        "scheme":"Bank_ID",
        "address":"gh.29.uk"
      },
      "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":"Bank_ID",
        "address":"gh.29.uk"
      },
      "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":"2017-09-19T00: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":"2017-09-19T00: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":"2017-09-19T00:00:00Z",
      "completed":"2017-09-19T00: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":"2017-09-19T00: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":"2017-09-19T00: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":"2017-09-19T00: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":"2017-09-19T00: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"
    }]
  }]
}
Roles Requeridos:
  • CanUseAccountFirehoseAtAnyBank - 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, New-Style,

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:

JSON response body fields:

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":"2017-09-19T00: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":"2017-09-19T00:00:00Z",
      "user":{
        "id":"5995d6a2-01b3-423c-a173-5481df49bdaf",
        "provider":"http://127.0.0.1:8080",
        "display_name":"OBP"
      }
    }
  }
}
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 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:

JSON response body fields:

Respuesta Exitosa Típica: 

								
									
{
  "id":"5995d6a2-01b3-423c-a173-5481df49bdaf",
  "this_account":{
    "id":"5995d6a2-01b3-423c-a173-5481df49bdaf",
    "holders":[{
      "name":"OBP",
      "is_alias":true
    }],
    "number":"123",
    "kind":"AC",
    "IBAN":"UK1234AD",
    "swift_bic":"UK1234AD",
    "bank":{
      "national_identifier":"OBP",
      "name":"OBP"
    }
  },
  "other_account":{
    "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":"2017-09-19T00: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":"2017-09-19T00: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":"2017-09-19T00:00:00Z",
    "completed":"2017-09-19T00: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":"2017-09-19T00: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":"2017-09-19T00: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":"2017-09-19T00: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":"2017-09-19T00:00:00Z",
      "user":{
        "id":"5995d6a2-01b3-423c-a173-5481df49bdaf",
        "provider":"http://127.0.0.1:8080",
        "display_name":"OBP"
      }
    }
  }
}
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 getTransactionByIdForBankAccount, operation_id: OBPv1.2.1-getTransactionByIdForBankAccount Tags: Transaction, PSD2,

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: 2022-05-29T00:00:43.120Z. NOTE! The default value is one year ago (2022-05-29T00:00:43.120Z).
  • to_date=DATE => example value: 2023-05-29T00:00:43.120Z. NOTE! The default value is now (2023-05-29T00:00:43.120Z).

Date format parameter: yyyy-MM-dd'T'HH:mm:ss.SSS'Z'(2017-09-19T02:31:05.000Z) ==> time zone is UTC.

eg3:?sort_direction=ASC&limit=100&offset=0&from_date=2017-09-19T02:31:05.000Z&to_date=2017-09-19T02:31:05.000Z

URL Parameters:

JSON response body fields:

Respuesta Exitosa Típica: 

								
									
{
  "transactions":[{
    "id":"5995d6a2-01b3-423c-a173-5481df49bdaf",
    "this_account":{
      "id":"String",
      "bank_routing":{
        "scheme":"Bank_ID",
        "address":"gh.29.uk"
      },
      "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":"Bank_ID",
        "address":"gh.29.uk"
      },
      "account_routings":[{
        "scheme":"AccountNumber",
        "address":"4930396"
      }]
    },
    "details":{
      "type":"AC",
      "description":"OBP",
      "posted":"2017-09-19T00:00:00Z",
      "completed":"2017-09-19T00: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"
    }]
  }]
}
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, New-Style,

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: 2022-05-29T00:00:43.123Z. NOTE! The default value is one year ago (2022-05-29T00:00:43.123Z).
  • to_date=DATE => example value: 2023-05-29T00:00:43.123Z. NOTE! The default value is now (2023-05-29T00:00:43.123Z).

Date format parameter: yyyy-MM-dd'T'HH:mm:ss.SSS'Z'(2017-09-19T02:31:05.000Z) ==> time zone is UTC.

eg3:?sort_direction=ASC&limit=100&offset=0&from_date=2017-09-19T02:31:05.000Z&to_date=2017-09-19T02:31:05.000Z

URL Parameters:

JSON response body fields:

Respuesta Exitosa Típica: 

								
									
{
  "transactions":[{
    "id":"String",
    "this_account":{
      "id":"String",
      "bank_routing":{
        "scheme":"Bank_ID",
        "address":"gh.29.uk"
      },
      "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":"Bank_ID",
        "address":"gh.29.uk"
      },
      "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":"2017-09-19T00: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":"2017-09-19T00: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":"2017-09-19T00:00:00Z",
      "completed":"2017-09-19T00: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":"2017-09-19T00: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":"2017-09-19T00: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":"2017-09-19T00: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":"2017-09-19T00: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"
    }]
  }]
}
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, New-Style,