API Explorer

v5.1.0 (9 APIs)

Banco
Cuentas
Vistas
Contrapartes
Transacciones

Create Bank

Create a new bank (Authenticated access).

The user creating this will be automatically assigned the Role CanCreateEntitlementAtOneBank.
Thus the User can manage the bank they create and assign Roles to other Users.

Only SANDBOX mode
The settlement accounts are created specified by the bank in the POST body.
Name and account id are created in accordance to the next rules:
- Incoming account (name: Default incoming settlement account, Account ID: OBP_DEFAULT_INCOMING_ACCOUNT_ID, currency: EUR)
- Outgoing account (name: Default outgoing settlement account, Account ID: OBP_DEFAULT_OUTGOING_ACCOUNT_ID, currency: EUR)

Authentication is Mandatory

JSON request body fields:

address:

bank_code: CGHZ

scheme: scheme value

bank_routings: bank routing in form of (scheme, address)

full_name: full name string

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

logo: logo url

website: www.openbankproject.com

JSON response body fields:

address:

bank_code: CGHZ

bank_routings: bank routing in form of (scheme, address)

full_name: full name string

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

logo: logo url

name: ACCOUNT_MANAGEMENT_FEE

scheme: scheme value

value: 5987953

website: www.openbankproject.com

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

Respuesta Exitosa Típica:

								
									
{ "id":"gh.29.uk", "bank_code":"CGHZ", "full_name":"bank fullName string", "logo":"bank logoUrl string", "website":"bank logoUrl string", "bank_routings":[{ "scheme":"scheme value", "address":"" }], "attributes":[{ "name":"ACCOUNT_MANAGEMENT_FEE", "value":"5987953" }] }
Roles Requeridos:
  • CanCreateBank - Please login to request this Role
Validaciones:
  • Required JSON Validation: No
  • Allowed Authentication Types: Not set
Posibles Errores:
  • OBP-10001: Incorrect json format.
  • OBP-20001: User not logged in. Authentication is required!
  • OBP-30210: Insufficient authorisation to Create Bank. You do not have the role CanCreateBank.
  • OBP-50000: Unknown Error.
  • OBP-20006: User is missing one or more roles:
Métodos de conector::
Version: OBPv5.0.0, function_name: by createBank, operation_id: OBPv5.0.0-createBank Tags: Bank,

Create Counterparty for any account (Explicit)

Create Counterparty for any Account. (Explicit)

In OBP, there are two types of Counterparty.

  • Explicit Counterparties (those here) which we create explicitly and are used in COUNTERPARTY Transaction Requests

  • Implicit Counterparties (AKA Other Accounts) which are generated automatically from the other sides of Transactions.

Explicit Counterparties are created for the account / view
They are how the user of the view (e.g. account owner) refers to the other side of the transaction

name : the human readable name (e.g. Piano teacher, Miss Nipa)

description : the human readable name (e.g. Piano teacher, Miss Nipa)

currency : counterparty account currency (e.g. EUR, GBP, USD, ...)

bank_routing_scheme : eg: bankId or bankCode or any other strings

bank_routing_address : eg: gh.29.uk, must be valid sandbox bankIds

account_routing_scheme : eg: AccountId or AccountNumber or any other strings

account_routing_address : eg: 1d65db7c-a7b2-4839-af41-95, must be valid accountIds

other_account_secondary_routing_scheme : eg: IBAN or any other strings

other_account_secondary_routing_address : if it is an IBAN, it should be unique for each counterparty.

other_branch_routing_scheme : eg: branchId or any other strings or you can leave it empty, not useful in sandbox mode.

other_branch_routing_address : eg: branch-id-123 or you can leave it empty, not useful in sandbox mode.

is_beneficiary : must be set to true in order to send payments to this counterparty

bespoke: It supports a list of key-value, you can add it to the counterparty.

bespoke.key : any info-key you want to add to this counterparty

bespoke.value : any info-value you want to add to this counterparty

The view specified by VIEW_ID must have the canAddCounterparty permission

A minimal example for TransactionRequestType == COUNTERPARTY
{
"name": "Tesobe1",
"description": "Good Company",
"currency": "EUR",
"other_bank_routing_scheme": "OBP",
"other_bank_routing_address": "gh.29.uk",
"other_account_routing_scheme": "OBP",
"other_account_routing_address": "8ca8a7e4-6d02-48e3-a029-0b2bf89de9f0",
"is_beneficiary": true,
"other_account_secondary_routing_scheme": "",
"other_account_secondary_routing_address": "",
"other_branch_routing_scheme": "",
"other_branch_routing_address": "",
"bespoke": []
}

A minimal example for TransactionRequestType == SEPA

{
"name": "Tesobe2",
"description": "Good Company",
"currency": "EUR",
"other_bank_routing_scheme": "OBP",
"other_bank_routing_address": "gh.29.uk",
"other_account_routing_scheme": "OBP",
"other_account_routing_address": "8ca8a7e4-6d02-48e3-a029-0b2bf89de9f0",
"other_account_secondary_routing_scheme": "IBAN",
"other_account_secondary_routing_address": "DE89 3704 0044 0532 0130 00",
"is_beneficiary": true,
"other_branch_routing_scheme": "",
"other_branch_routing_address": "",
"bespoke": []
}

Authentication is Mandatory

URL Parameters:

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

BANK_ID: gh.29.uk

VIEW_ID: owner

JSON request body fields:

bespoke:

currency: EUR

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

is_beneficiary: false

key: CustomerNumber

name: ACCOUNT_MANAGEMENT_FEE

other_account_routing_address:

other_account_routing_scheme:

other_account_secondary_routing_address:

other_account_secondary_routing_scheme:

other_bank_routing_address:

other_bank_routing_scheme:

other_branch_routing_address:

other_branch_routing_scheme:

value: 5987953

JSON response body fields:

bespoke:

corporate_location: 10

counterparty_id: 9fg8a7e4-6d02-40e3-a129-0b2bf89de8uh

created_by_user_id:

currency: EUR

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

image_url:

is_beneficiary: false

key: CustomerNumber

latitude: 38.8951

longitude: -77.0364

metadata:

more_info: More information about this fee

name: ACCOUNT_MANAGEMENT_FEE

open_corporates_url:

other_account_routing_address:

other_account_routing_scheme:

other_account_secondary_routing_address:

other_account_secondary_routing_scheme:

other_bank_routing_address:

other_bank_routing_scheme:

other_branch_routing_address:

other_branch_routing_scheme:

physical_location:

private_alias:

provider: ETHEREUM

public_alias:

this_account_id:

this_bank_id:

this_view_id:

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

user:

username: felixsmith

value: 5987953

Respuesta Exitosa Típica:

								
									
{ "name":"CounterpartyName", "description":"My landlord", "currency":"EUR", "created_by_user_id":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1", "this_bank_id":"gh.29.uk", "this_account_id":"8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0", "this_view_id":"owner", "counterparty_id":"9fg8a7e4-6d02-40e3-a129-0b2bf89de8uh", "other_bank_routing_scheme":"OBP", "other_bank_routing_address":"gh.29.uk", "other_branch_routing_scheme":"OBP", "other_branch_routing_address":"12f8a9e6-c2b1-407a-8bd0-421b7119307e", "other_account_routing_scheme":"OBP", "other_account_routing_address":"36f8a9e6-c2b1-407a-8bd0-421b7119307e", "other_account_secondary_routing_scheme":"IBAN", "other_account_secondary_routing_address":"DE89370400440532013000", "is_beneficiary":true, "bespoke":[{ "key":"englishName", "value":"english Name" }], "metadata":{ "public_alias":"String", "more_info":"String", "url":"String", "image_url":"String", "open_corporates_url":"String", "corporate_location":{ "latitude":11.45, "longitude":11.45, "date":"1100-01-01T00:00:00Z", "user":{ "id":"123", "provider":"http://127.0.0.1:8080", "username":"felixsmith" } }, "physical_location":{ "latitude":11.45, "longitude":11.45, "date":"1100-01-01T00:00:00Z", "user":{ "id":"123", "provider":"http://127.0.0.1:8080", "username":"felixsmith" } }, "private_alias":"String" } }
Roles Requeridos:
  • CanCreateCounterparty - Please login to request this Role
  • CanCreateCounterpartyAtAnyBank - 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-30110: Invalid Account Id. The ACCOUNT_ID should only contain 0-9/a-z/A-Z/'-'/'.'/'_', the length should be smaller than 255.
  • OBP-30111: Invalid Bank Id. The BANK_ID should only contain 0-9/a-z/A-Z/'-'/'.'/'_', the length should be smaller than 255.
  • 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-30003: Account not found. Please specify a valid value for ACCOUNT_ID.
  • OBP-10001: Incorrect json format.
  • OBP-10003: Invalid Currency Value. It should be three letters ISO Currency Code.
  • OBP-30005: View not found for Account. Please specify a valid value for VIEW_ID
  • OBP-30014: Counterparty already exists. Please specify a different value for BANK_ID or ACCOUNT_ID or VIEW_ID or NAME.
  • OBP-50000: Unknown Error.
  • OBP-20006: User is missing one or more roles:
Métodos de conector::
Version: OBPv4.0.0, function_name: by createCounterpartyForAnyAccount, operation_id: OBPv4.0.0-createCounterpartyForAnyAccount Tags: Counterparty, Account,

Get Counterparties for any account (Explicit)

Get the Counterparties (Explicit) for any account .

Authentication is Mandatory

URL Parameters:

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

BANK_ID: gh.29.uk

VIEW_ID: owner

JSON response body fields:

bespoke:

counterparties:

counterparty_id: 9fg8a7e4-6d02-40e3-a129-0b2bf89de8uh

created_by_user_id:

currency: EUR

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

is_beneficiary: false

key: CustomerNumber

name: ACCOUNT_MANAGEMENT_FEE

other_account_routing_address:

other_account_routing_scheme:

other_account_secondary_routing_address:

other_account_secondary_routing_scheme:

other_bank_routing_address:

other_bank_routing_scheme:

other_branch_routing_address:

other_branch_routing_scheme:

this_account_id:

this_bank_id:

this_view_id:

value: 5987953

Respuesta Exitosa Típica:

								
									
{ "counterparties":[{ "name":"CounterpartyName", "description":"My landlord", "currency":"EUR", "created_by_user_id":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1", "this_bank_id":"gh.29.uk", "this_account_id":"8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0", "this_view_id":"owner", "counterparty_id":"9fg8a7e4-6d02-40e3-a129-0b2bf89de8uh", "other_bank_routing_scheme":"OBP", "other_bank_routing_address":"gh.29.uk", "other_branch_routing_scheme":"OBP", "other_branch_routing_address":"12f8a9e6-c2b1-407a-8bd0-421b7119307e", "other_account_routing_scheme":"OBP", "other_account_routing_address":"36f8a9e6-c2b1-407a-8bd0-421b7119307e", "other_account_secondary_routing_scheme":"IBAN", "other_account_secondary_routing_address":"DE89370400440532013000", "is_beneficiary":true, "bespoke":[{ "key":"englishName", "value":"english Name" }] }] }
Roles Requeridos:
  • CanGetCounterparties - Please login to request this Role
  • CanGetCounterpartiesAtAnyBank - 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-50000: Unknown Error.
  • OBP-20006: User is missing one or more roles:
Métodos de conector::
Version: OBPv4.0.0, function_name: by getCounterpartiesForAnyAccount, operation_id: OBPv4.0.0-getCounterpartiesForAnyAccount Tags: Counterparty, Payment Initiation Service (PIS), PSD2, Account,

Get Counterparty by name for any account (Explicit)

Authentication is Mandatory

URL Parameters:

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

BANK_ID: gh.29.uk

COUNTERPARTY_NAME: John Smith Ltd.

VIEW_ID: owner

JSON response body fields:

bespoke:

corporate_location: 10

counterparty_id: 9fg8a7e4-6d02-40e3-a129-0b2bf89de8uh

created_by_user_id:

currency: EUR

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

image_url:

is_beneficiary: false

key: CustomerNumber

latitude: 38.8951

longitude: -77.0364

metadata:

more_info: More information about this fee

name: ACCOUNT_MANAGEMENT_FEE

open_corporates_url:

other_account_routing_address:

other_account_routing_scheme:

other_account_secondary_routing_address:

other_account_secondary_routing_scheme:

other_bank_routing_address:

other_bank_routing_scheme:

other_branch_routing_address:

other_branch_routing_scheme:

physical_location:

private_alias:

provider: ETHEREUM

public_alias:

this_account_id:

this_bank_id:

this_view_id:

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

user:

username: felixsmith

value: 5987953

Respuesta Exitosa Típica:

								
									
{ "name":"CounterpartyName", "description":"My landlord", "currency":"EUR", "created_by_user_id":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1", "this_bank_id":"gh.29.uk", "this_account_id":"8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0", "this_view_id":"owner", "counterparty_id":"9fg8a7e4-6d02-40e3-a129-0b2bf89de8uh", "other_bank_routing_scheme":"OBP", "other_bank_routing_address":"gh.29.uk", "other_branch_routing_scheme":"OBP", "other_branch_routing_address":"12f8a9e6-c2b1-407a-8bd0-421b7119307e", "other_account_routing_scheme":"OBP", "other_account_routing_address":"36f8a9e6-c2b1-407a-8bd0-421b7119307e", "other_account_secondary_routing_scheme":"IBAN", "other_account_secondary_routing_address":"DE89370400440532013000", "is_beneficiary":true, "bespoke":[{ "key":"englishName", "value":"english Name" }], "metadata":{ "public_alias":"String", "more_info":"String", "url":"String", "image_url":"String", "open_corporates_url":"String", "corporate_location":{ "latitude":11.45, "longitude":11.45, "date":"1100-01-01T00:00:00Z", "user":{ "id":"123", "provider":"http://127.0.0.1:8080", "username":"felixsmith" } }, "physical_location":{ "latitude":11.45, "longitude":11.45, "date":"1100-01-01T00:00:00Z", "user":{ "id":"123", "provider":"http://127.0.0.1:8080", "username":"felixsmith" } }, "private_alias":"String" } }
Roles Requeridos:
  • CanGetCounterpartyAtAnyBank - Please login to request this Role
  • CanGetCounterparty - 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-30110: Invalid Account Id. The ACCOUNT_ID should only contain 0-9/a-z/A-Z/'-'/'.'/'_', the length should be smaller than 255.
  • OBP-30111: Invalid Bank Id. The BANK_ID should only contain 0-9/a-z/A-Z/'-'/'.'/'_', the length should be smaller than 255.
  • 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-30005: View not found for Account. Please specify a valid value for VIEW_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 getCounterpartyByNameForAnyAccount, operation_id: OBPv4.0.0-getCounterpartyByNameForAnyAccount Tags: Counterparty, Account,

Link a Customer to a Account

Authentication is Mandatory

URL Parameters:

BANK_ID: gh.29.uk

JSON request body fields:

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

bank_id: gh.29.uk

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

relationship_type: Owner

JSON response body fields:

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

bank_id: gh.29.uk

customer_account_link_id: xyz8a7e4-6d02-40e3-a129-0b2bf89de8uh

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

relationship_type: Owner

Validaciones:
  • Required JSON Validation: No
  • Allowed Authentication Types: Not set
Version: OBPv5.0.0, function_name: by createCustomerAccountLink, operation_id: OBPv5.0.0-createCustomerAccountLink Tags: Customer, Account,

Get Customer Account Links by ACCOUNT_ID

Get Customer Account Links by ACCOUNT_ID

Authentication is Mandatory

URL Parameters:

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

BANK_ID: gh.29.uk

JSON response body fields:

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

bank_id: gh.29.uk

customer_account_link_id: xyz8a7e4-6d02-40e3-a129-0b2bf89de8uh

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

links: links

relationship_type: Owner

Respuesta Exitosa Típica:

								
									
{ "links":[{ "customer_account_link_id":"xyz8a7e4-6d02-40e3-a129-0b2bf89de8uh", "customer_id":"7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh", "bank_id":"gh.29.uk", "account_id":"8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0", "relationship_type":"Owner" }] }
Roles Requeridos:
  • CanGetCustomerAccountLinks - 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: OBPv5.0.0, function_name: by getCustomerAccountLinksByBankIdAccountId, operation_id: OBPv5.0.0-getCustomerAccountLinksByBankIdAccountId Tags: Customer,

Get Customer Account Links by CUSTOMER_ID

Get Customer Account Links by CUSTOMER_ID

Authentication is Mandatory

URL Parameters:

BANK_ID: gh.29.uk

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

JSON response body fields:

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

bank_id: gh.29.uk

customer_account_link_id: xyz8a7e4-6d02-40e3-a129-0b2bf89de8uh

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

links: links

relationship_type: Owner

Respuesta Exitosa Típica:

								
									
{ "links":[{ "customer_account_link_id":"xyz8a7e4-6d02-40e3-a129-0b2bf89de8uh", "customer_id":"7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh", "bank_id":"gh.29.uk", "account_id":"8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0", "relationship_type":"Owner" }] }
Roles Requeridos:
  • CanGetCustomerAccountLinks - 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-30046: Customer not found. Please specify a valid value for CUSTOMER_ID.
  • OBP-20006: User is missing one or more roles:
  • OBP-50000: Unknown Error.
Métodos de conector::
Version: OBPv5.0.0, function_name: by getCustomerAccountLinksByCustomerId, operation_id: OBPv5.0.0-getCustomerAccountLinksByCustomerId Tags: Customer,

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

Respuesta Exitosa Típica:

								
									
{ "transaction_attribute_id":"7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh", "name":"HOUSE_RENT", "type":"DATE_WITH_DAY", "value":"123456789" }
Roles Requeridos:
  • CanCreateTransactionAttributeAtOneBank - 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 createTransactionAttribute, operation_id: OBPv4.0.0-createTransactionAttribute Tags: Transaction,

Create Historical Transactions

Create historical transactions at one Bank

Use this endpoint to create transactions between any two accounts at the same bank.
From account and to account must be at the same bank.
Example:
{
"from_account_id": "1ca8a7e4-6d02-48e3-a029-0b2bf89de9f0",
"to_account_id": "2ca8a7e4-6d02-48e3-a029-0b2bf89de9f0",
"value": {
"currency": "GBP",
"amount": "10"
},
"description": "this is for work",
"posted": "2017-09-19T02:31:05Z",
"completed": "2017-09-19T02:31:05Z",
"type": "SANDBOX_TAN",
"charge_policy": "SHARED"
}

This call is experimental.

Authentication is Mandatory

URL Parameters:

BANK_ID: gh.29.uk

JSON request body fields:

amount: 10.12

charge_policy: SHARED

completed: 2020-01-27

currency: EUR

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

from_account_id: from_account_id

posted: 2020-01-27

to_account_id: to_account_id

type:

value: 5987953

JSON response body fields:

amount: 10.12

charge_policy: SHARED

completed: 2020-01-27

currency: EUR

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

from:

posted: 2020-01-27

to:

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

transaction_request_type: SEPA

value: 5987953

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

bank_id: gh.29.uk

counterparty_id: 9fg8a7e4-6d02-40e3-a129-0b2bf89de8uh

Respuesta Exitosa Típica:

								
									
{ "transaction_id":"2fg8a7e4-6d02-40e3-a129-0b2bf89de8ub", "from":{ "bank_id":"gh.29.uk", "account_id":"8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0", "counterparty_id":"9fg8a7e4-6d02-40e3-a129-0b2bf89de8uh" }, "to":{ "bank_id":"gh.29.uk", "account_id":"8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0", "counterparty_id":"9fg8a7e4-6d02-40e3-a129-0b2bf89de8uh" }, "value":{ "currency":"EUR", "amount":"0" }, "description":"this is for work", "posted":"1100-01-01T01:01:01Z", "completed":"1100-01-01T01:01:01Z", "transaction_request_type":"SANDBOX_TAN", "charge_policy":"SHARED" }
Roles Requeridos:
  • CanCreateHistoricalTransactionAtBank - Please login to request this Role
Validaciones:
  • Required JSON Validation: No
  • Allowed Authentication Types: Not set
Posibles Errores:
  • OBP-10001: Incorrect json format.
  • OBP-30001: Bank not found. Please specify a valid value for BANK_ID.
  • OBP-30003: Account not found. Please specify a valid value for ACCOUNT_ID.
  • OBP-30017: Counterparty not found. Please specify a valid value for COUNTERPARTY_ID.
  • OBP-10002: Invalid Number. Could not convert value to a number.
  • OBP-40008: Can't send a payment with a value of 0 or less.
  • OBP-40003: Transaction Request Currency must be the same as From Account Currency.
  • OBP-50000: Unknown Error.
  • OBP-20001: User not logged in. Authentication is required!
  • OBP-20006: User is missing one or more roles:
Métodos de conector::
Version: OBPv4.0.0, function_name: by createHistoricalTransactionAtBank, operation_id: OBPv4.0.0-createHistoricalTransactionAtBank Tags: Transaction-Request,