Logo

API EXPLORER

PSD2 APIs v2.1.0 (all tags) (16)

These APIs support customer account and transaction history, payments and pricing transparency.

Bank

Accounts

Views

Counterparties

Transactions

Get Account by Id (Core)

Information returned about the account specified by ACCOUNT_ID:

  • Number
  • Owners
  • Type
  • Balance
  • IBAN

This call returns the owner view and requires access to that view.

OAuth authentication is required

Typical Successful Response:

                            
                                
{ "id":"8ca8a7e4-6d02-48e3-a029-0b2bf89de9f0", "label":"NoneLabel", "number":"123", "owners":[{ "id":"5995d6a2-01b3-423c-a173-5481df49bdaf", "provider":"OBP", "display_name":"OBP" }], "type":"OBP", "balance":{ "currency":"EUR", "amount":"10" }, "IBAN":"GR1301720530005053000582373", "swift_bic":"UKTF3049auf", "bank_id":"gh.29.uk", "account_routing":{ "scheme":"IBAN", "address":"DE89 3704 0044 0532 0130 00" } }
Possible Errors:
  • OBP-30018: Bank Account not found. Please specify valid values for BANK_ID and ACCOUNT_ID.
  • OBP-50000: Unknown Error.
Implmented in 2_0_0 by getCoreAccountById

Get Accounts at all Banks (Private)

Get private accounts at all banks (Authenticated access) Returns the list of accounts containing private views for the user at all banks. For each account the API returns the ID and the available views.

Authentication is Mandatory

Typical Successful Response:

                            
                                
{ "accounts":[{ "id":"8ca8a7e4-6d02-48e3-a029-0b2bf89de9f0", "label":"NoneLabel", "bank_id":"gh.29.uk", "_links":[] }] }
Possible Errors:
  • OBP-50000: Unknown Error.
Implmented in 2_0_0 by corePrivateAccountsAllBanks

Get Other Account by Id.

Returns data about the Other Account that has shared at least one transaction with ACCOUNT_ID at BANK_ID. Authentication is Optional Authentication is required if the view is not public.

Typical Successful Response:

                            
                                
{ "id":"5995d6a2-01b3-423c-a173-5481df49bdaf", "holder":{ "name":"OBP", "is_alias":true }, "number":"123", "kind":"3456", "IBAN":"UK234DB", "swift_bic":"UK12321DB", "bank":{ "national_identifier":"OBP", "name":"OBP" }, "metadata":{ "public_alias":"NONE", "private_alias":"NONE", "more_info":"www.openbankproject.com", "URL":"www.openbankproject.com", "image_URL":"www.openbankproject.com", "open_corporates_URL":"www.openbankproject.com", "corporate_location":{ "latitude":1.231, "longitude":1.231, "date":"2013-01-22T00:08:00Z", "user":{ "id":"5995d6a2-01b3-423c-a173-5481df49bdaf", "provider":"OBP", "display_name":"OBP" } }, "physical_location":{ "latitude":1.231, "longitude":1.231, "date":"2013-01-22T00:08:00Z", "user":{ "id":"5995d6a2-01b3-423c-a173-5481df49bdaf", "provider":"OBP", "display_name":"OBP" } } } }
Possible Errors:
  • OBP-30018: Bank Account not found. Please specify valid values for BANK_ID and ACCOUNT_ID.
  • OBP-50000: Unknown Error.
Implmented in 1_2_1 by getOtherAccountByIdForBankAccount

Get Transactions for Account (Core)

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

Authentication is required.

Possible custom headers for pagination:

  • obp_sort_by=CRITERIA ==> default value: "completed" field
  • obp_sort_direction=ASC/DESC ==> default value: DESC
  • obp_limit=NUMBER ==> default value: 50
  • obp_offset=NUMBER ==> default value: 0
  • obp_from_date=DATE => default value: date of the oldest transaction registered (format below)
  • obp_to_date=DATE => default value: date of the newest transaction registered (format below)

Date format parameter: "yyyy-MM-dd'T'HH:mm:ss.SSS'Z'" (2014-07-01T00:00:00.000Z) ==> time zone is UTC.

Typical Successful Response:

                            
                                
{ "id":"8ca8a7e4-6d02-48e3-a029-0b2bf89de9f0", "label":"NoneLabel", "number":"123", "owners":[{ "id":"5995d6a2-01b3-423c-a173-5481df49bdaf", "provider":"OBP", "display_name":"OBP" }], "type":"OBP", "balance":{ "currency":"EUR", "amount":"10" }, "IBAN":"GR1301720530005053000582373", "swift_bic":"UKTF3049auf", "bank_id":"gh.29.uk", "account_routing":{ "scheme":"IBAN", "address":"DE89 3704 0044 0532 0130 00" } }
Possible Errors:
  • OBP-30018: Bank Account not found. Please specify valid values for BANK_ID and ACCOUNT_ID.
  • OBP-50000: Unknown Error.
Implmented in 2_0_0 by getCoreTransactionsForBankAccount

Get private accounts at one bank (Authenticated access).

Returns the list of private (non-public) accounts at BANK_ID that the user has access to. For each account the API returns the ID and the available views.

If you want to see more information on the Views, use the Account Detail call. If you want less information about the account, use the /my accounts call

Authentication is Mandatory

Typical Successful Response:

                            
                                
{ "accounts":[{ "id":"8ca8a7e4-6d02-48e3-a029-0b2bf89de9f0", "label":"NoneLabel", "bank_id":"gh.29.uk", "views_available":[{ "id":"1", "short_name":"HHH", "is_public":true }] }] }
Possible Errors:
  • OBP-20001: User not logged in. Authentication is required!
  • OBP-30001: Bank not found. Please specify a valid value for BANK_ID.
  • OBP-50000: Unknown Error.
Implmented in 2_0_0 by privateAccountsAtOneBank

Get Transaction Types offered by the bank

Get Transaction Types for the bank specified by BANK_ID:

Lists the possible Transaction Types available at the bank (as opposed to Transaction Request Types which are the possible ways Transactions can be created by this API Server).

  • id : Unique transaction type id across the API instance. SHOULD be a UUID. MUST be unique.
  • bank_id : The bank that supports this TransactionType
  • short_code : A short code (SHOULD have no-spaces) which MUST be unique across the bank. May be stored with Transactions to link here
  • summary : A succinct summary
  • description : A longer description
  • charge : The charge to the customer for each one of these

Authentication is Optional

Typical Successful Response:

                            
                                
{ "transaction_types":[{ "id":{ "value":"123" }, "bank_id":"PlaceholderString", "short_code":"PlaceholderString", "summary":"PlaceholderString", "description":"PlaceholderString", "charge":{ "currency":"EUR", "amount":"10" } }] }
Possible Errors:
  • OBP-30001: Bank not found. Please specify a valid value for BANK_ID.
  • OBP-50000: Unknown Error.
Implmented in 2_0_0 by getTransactionTypes

Get Other Accounts of one Account.

Returns data about all the other accounts that have shared at least one transaction with the ACCOUNT_ID at BANK_ID. Authentication is Optional Authentication is required if the view VIEW_ID is not public.

Typical Successful Response:

                            
                                
{ "other_accounts":[{ "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":"2013-01-22T00:08:00Z", "user":{ "id":"5995d6a2-01b3-423c-a173-5481df49bdaf", "provider":"OBP", "display_name":"OBP" } }, "physical_location":{ "latitude":1.231, "longitude":1.231, "date":"2013-01-22T00:08:00Z", "user":{ "id":"5995d6a2-01b3-423c-a173-5481df49bdaf", "provider":"OBP", "display_name":"OBP" } } } }] }
Possible Errors:
  • OBP-30018: Bank Account not found. Please specify valid values for BANK_ID and ACCOUNT_ID.
  • OBP-50000: Unknown Error.
Implmented in 1_2_1 by getOtherAccountsForBankAccount

Answer Transaction Request Challenge.

In Sandbox mode, any string that can be converted to a positive integer will be accepted as an answer.

Typical Successful Response:

                            
                                
{ "id":"82f92531-9c63-4246-abfc-96c20ec46188", "type":"SANDBOX_TAN", "from":{ "bank_id":"gh.29.uk", "account_id":"8ca8a7e4-6d02-48e3-a029-0b2bf89de9f0" }, "details":[], "transaction_ids":"666666-9c63-4246-abfc-96c20ec46188", "status":"COMPLETED", "start_date":"2013-01-22T00:08:00Z", "end_date":"2013-01-22T00:08:00Z", "challenge":{ "id":"be1a183d-b301-4b83-b855-5eeffdd3526f", "allowed_attempts":3, "challenge_type":"SANDBOX_TAN" }, "charge":{ "summary":"Good", "value":{ "currency":"EUR", "amount":"10" } } }
Possible Errors:
  • OBP-20001: User not logged in. Authentication is required!
  • 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-30110: Invalid Account Id. The ACCOUNT_ID should only contain 0-9/a-z/A-Z/'-'/'.'/'_', the length should be smaller than 255.
  • OBP-10001: Incorrect json format.
  • OBP-30001: Bank not found. Please specify a valid value for BANK_ID.
  • OBP-20017: Current user does not have access to the view. Please specify a valid value for VIEW_ID.
  • OBP-40011: Transaction Request Status is not INITIATED.
  • OBP-40009: The TRANSACTION_REQUEST_TYPE has changed.
  • OBP-40010: Invalid Challenge Id. Please specify a valid value for CHALLENGE_ID.
  • OBP-40014: Sorry, you've used up your allowed attempts.
  • OBP-00003: Transaction Requests is disabled in this API instance.
  • OBP-50000: Unknown Error.
Implmented in 2_1_0 by answerTransactionRequestChallenge

Create Transaction Request (COUNTERPARTY)

Special instructions for COUNTERPARTY:

When using a COUNTERPARTY to create a Transaction Request, specificy the counterparty_id in the body of the request. The routing details of the counterparty will be forwarded for the transfer.

Initiate a Payment via creating a Transaction Request.

In OBP, a transaction request may or may not result in a transaction. However, a transaction only has one possible state: completed.

A Transaction Request can have one of several states.

Transactions are modeled on items in a bank statement that represent the movement of money.

Transaction Requests are requests to move money which may or may not succeeed and thus result in a Transaction.

A Transaction Request might create a security challenge that needs to be answered before the Transaction Request proceeds.

Transaction Requests contain charge information giving the client the opportunity to proceed or not (as long as the challenge level is appropriate).

Transaction Requests can have one of several Transaction Request Types which expect different bodies. The escaped body is returned in the details key of the GET response. This provides some commonality and one URL for many different payment or transfer types with enough flexibility to validate them differently.

The payer is set in the URL. Money comes out of the BANK_ID and ACCOUNT_ID specified in the URL.

In sandbox mode, TRANSACTION_REQUEST_TYPE is commonly set to SANDBOX_TAN. See getTransactionRequestTypesSupportedByBank for all supported types.

In sandbox mode, if the amount is less than 1000 EUR (any currency, unless it is set differently on this server), the transaction request will create a transaction without a challenge, else the Transaction Request will be set to INITIALISED and a challenge will need to be answered.

If a challenge is created you must answer it using Answer Transaction Request Challenge before the Transaction is created.

You can transfer between different currency accounts. (new in 2.0.0). The currency in body must match the sending account.

The following static FX rates are available in sandbox mode:

{ "XAF":{ "AUD":1.0, "KRW":1.87975, "JOD":1.0, "GBP":0.00131092, "AED":0.00601555, "INR":0.110241, "JPY":0.185328, "USD":0.00163773, "EUR":0.00152449 }, "AUD":{ "XAF":762.826, "KRW":1433.92, "JOD":1.0, "AED":4.58882, "INR":84.095, "JPY":141.373, "USD":0.79, "EUR":0.67 }, "KRW":{ "XAF":0.531986, "AUD":1.0, "JOD":1.0, "GBP":6.97389E-4, "AED":0.00320019, "INR":0.0586469, "JPY":0.0985917, "USD":8.7125E-4, "EUR":8.11008E-4 }, "JOD":{ "XAF":1.0, "AUD":1.0, "KRW":1.0, "GBP":1.0, "AED":1.0, "INR":1.0, "JPY":1.0, "USD":1.0, "EUR":1.0 }, "GBP":{ "XAF":762.826, "AUD":1.0, "KRW":1433.92, "JOD":1.0, "AED":4.58882, "INR":84.095, "JPY":141.373, "USD":1.2493, "EUR":1.16278 }, "AED":{ "XAF":166.236, "AUD":1.0, "KRW":312.482, "GBP":0.217921, "AED":1.0, "INR":18.3255, "JPY":30.8081, "USD":0.27225, "EUR":0.253425 }, "INR":{ "XAF":9.07101, "AUD":1.0, "KRW":17.0512, "JOD":1.0, "GBP":0.0118913, "AED":0.0545671, "JPY":1.68111, "USD":0.0148559, "EUR":0.0138287 }, "JPY":{ "XAF":5.39585, "AUD":1.0, "KRW":10.1428, "JOD":1.0, "GBP":0.0070735, "AED":0.032459, "INR":0.594846, "USD":0.00883695, "EUR":0.00822592 }, "USD":{ "XAF":610.601, "AUD":1.0, "KRW":1147.78, "JOD":1.0, "GBP":0.800446, "AED":3.6731, "INR":67.3135, "JPY":113.161, "EUR":0.930886 }, "EUR":{ "XAF":655.957, "AUD":1.0, "KRW":1233.03, "JOD":1.0, "GBP":0.860011, "AED":3.94594, "INR":72.3136, "JPY":121.567, "USD":1.07428 } }

Transaction Requests satisfy PSD2 requirements thus:

1) A transaction can be initiated by a third party application.

2) The customer is informed of the charge that will incurred.

3) The call supports delegated authentication (OAuth)

See this python code for a complete example of this flow.

There is further documentation here

Authentication is Mandatory

Typical Successful Response:

                            
                                
{ "id":"4050046c-63b3-4868-8a22-14b4181d33a6", "type":"SANDBOX_TAN", "from":{ "bank_id":"gh.29.uk", "account_id":"8ca8a7e4-6d02-48e3-a029-0b2bf89de9f0" }, "details":[], "transaction_ids":["902ba3bb-dedd-45e7-9319-2fd3f2cd98a1"], "status":"COMPLETED", "start_date":"2013-01-22T00:08:00Z", "end_date":"2013-01-22T00:08:00Z", "challenge":{ "id":"be1a183d-b301-4b83-b855-5eeffdd3526f", "allowed_attempts":3, "challenge_type":"SANDBOX_TAN" }, "charge":{ "summary":"Good", "value":{ "currency":"EUR", "amount":"10" } } }
Possible Errors:
  • OBP-20001: User not logged in. Authentication is required!
  • OBP-20001: User not logged in. Authentication is required!
  • 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-30110: Invalid Account Id. The ACCOUNT_ID should only contain 0-9/a-z/A-Z/'-'/'.'/'_', the length should be smaller than 255.
  • 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-30005: View not found for Account. Please specify a valid value for VIEW_ID
  • OBP-40002: Insufficient authorisation to create TransactionRequest. The Transaction Request could not be created because you don't have access to the owner view of the from account or you don't have access to canCreateAnyTransactionRequest.
  • OBP-20017: Current user does not have access to the view. Please specify a valid value for VIEW_ID.
  • OBP-40001: Invalid value for TRANSACTION_REQUEST_TYPE
  • OBP-10001: Incorrect json format.
  • 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-00003: Transaction Requests is disabled in this API instance.
  • OBP-50000: Unknown Error.
Implmented in 2_1_0 by createTransactionRequestCouterparty

Create Transaction Request (FREE_FORM).

Initiate a Payment via creating a Transaction Request.

In OBP, a transaction request may or may not result in a transaction. However, a transaction only has one possible state: completed.

A Transaction Request can have one of several states.

Transactions are modeled on items in a bank statement that represent the movement of money.

Transaction Requests are requests to move money which may or may not succeeed and thus result in a Transaction.

A Transaction Request might create a security challenge that needs to be answered before the Transaction Request proceeds.

Transaction Requests contain charge information giving the client the opportunity to proceed or not (as long as the challenge level is appropriate).

Transaction Requests can have one of several Transaction Request Types which expect different bodies. The escaped body is returned in the details key of the GET response. This provides some commonality and one URL for many different payment or transfer types with enough flexibility to validate them differently.

The payer is set in the URL. Money comes out of the BANK_ID and ACCOUNT_ID specified in the URL.

In sandbox mode, TRANSACTION_REQUEST_TYPE is commonly set to SANDBOX_TAN. See getTransactionRequestTypesSupportedByBank for all supported types.

In sandbox mode, if the amount is less than 1000 EUR (any currency, unless it is set differently on this server), the transaction request will create a transaction without a challenge, else the Transaction Request will be set to INITIALISED and a challenge will need to be answered.

If a challenge is created you must answer it using Answer Transaction Request Challenge before the Transaction is created.

You can transfer between different currency accounts. (new in 2.0.0). The currency in body must match the sending account.

The following static FX rates are available in sandbox mode:

{ "XAF":{ "AUD":1.0, "KRW":1.87975, "JOD":1.0, "GBP":0.00131092, "AED":0.00601555, "INR":0.110241, "JPY":0.185328, "USD":0.00163773, "EUR":0.00152449 }, "AUD":{ "XAF":762.826, "KRW":1433.92, "JOD":1.0, "AED":4.58882, "INR":84.095, "JPY":141.373, "USD":0.79, "EUR":0.67 }, "KRW":{ "XAF":0.531986, "AUD":1.0, "JOD":1.0, "GBP":6.97389E-4, "AED":0.00320019, "INR":0.0586469, "JPY":0.0985917, "USD":8.7125E-4, "EUR":8.11008E-4 }, "JOD":{ "XAF":1.0, "AUD":1.0, "KRW":1.0, "GBP":1.0, "AED":1.0, "INR":1.0, "JPY":1.0, "USD":1.0, "EUR":1.0 }, "GBP":{ "XAF":762.826, "AUD":1.0, "KRW":1433.92, "JOD":1.0, "AED":4.58882, "INR":84.095, "JPY":141.373, "USD":1.2493, "EUR":1.16278 }, "AED":{ "XAF":166.236, "AUD":1.0, "KRW":312.482, "GBP":0.217921, "AED":1.0, "INR":18.3255, "JPY":30.8081, "USD":0.27225, "EUR":0.253425 }, "INR":{ "XAF":9.07101, "AUD":1.0, "KRW":17.0512, "JOD":1.0, "GBP":0.0118913, "AED":0.0545671, "JPY":1.68111, "USD":0.0148559, "EUR":0.0138287 }, "JPY":{ "XAF":5.39585, "AUD":1.0, "KRW":10.1428, "JOD":1.0, "GBP":0.0070735, "AED":0.032459, "INR":0.594846, "USD":0.00883695, "EUR":0.00822592 }, "USD":{ "XAF":610.601, "AUD":1.0, "KRW":1147.78, "JOD":1.0, "GBP":0.800446, "AED":3.6731, "INR":67.3135, "JPY":113.161, "EUR":0.930886 }, "EUR":{ "XAF":655.957, "AUD":1.0, "KRW":1233.03, "JOD":1.0, "GBP":0.860011, "AED":3.94594, "INR":72.3136, "JPY":121.567, "USD":1.07428 } }

Transaction Requests satisfy PSD2 requirements thus:

1) A transaction can be initiated by a third party application.

2) The customer is informed of the charge that will incurred.

3) The call supports delegated authentication (OAuth)

See this python code for a complete example of this flow.

There is further documentation here

Authentication is Mandatory

Typical Successful Response:

                            
                                
{ "id":"4050046c-63b3-4868-8a22-14b4181d33a6", "type":"SANDBOX_TAN", "from":{ "bank_id":"gh.29.uk", "account_id":"8ca8a7e4-6d02-48e3-a029-0b2bf89de9f0" }, "details":[], "transaction_ids":["902ba3bb-dedd-45e7-9319-2fd3f2cd98a1"], "status":"COMPLETED", "start_date":"2013-01-22T00:08:00Z", "end_date":"2013-01-22T00:08:00Z", "challenge":{ "id":"be1a183d-b301-4b83-b855-5eeffdd3526f", "allowed_attempts":3, "challenge_type":"SANDBOX_TAN" }, "charge":{ "summary":"Good", "value":{ "currency":"EUR", "amount":"10" } } }
Possible Errors:
  • OBP-20001: User not logged in. Authentication is required!
  • OBP-20001: User not logged in. Authentication is required!
  • 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-30110: Invalid Account Id. The ACCOUNT_ID should only contain 0-9/a-z/A-Z/'-'/'.'/'_', the length should be smaller than 255.
  • 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-30005: View not found for Account. Please specify a valid value for VIEW_ID
  • OBP-40002: Insufficient authorisation to create TransactionRequest. The Transaction Request could not be created because you don't have access to the owner view of the from account or you don't have access to canCreateAnyTransactionRequest.
  • OBP-20017: Current user does not have access to the view. Please specify a valid value for VIEW_ID.
  • OBP-40001: Invalid value for TRANSACTION_REQUEST_TYPE
  • OBP-10001: Incorrect json format.
  • 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-00003: Transaction Requests is disabled in this API instance.
  • OBP-50000: Unknown Error.
Implmented in 2_1_0 by createTransactionRequestFreeForm

Create Transaction Request (SANDBOX_TAN)

When using SANDBOX_TAN, the payee is set in the request body.

Money goes into the BANK_ID and ACCOUNT_ID specified in the request body.

Initiate a Payment via creating a Transaction Request.

In OBP, a transaction request may or may not result in a transaction. However, a transaction only has one possible state: completed.

A Transaction Request can have one of several states.

Transactions are modeled on items in a bank statement that represent the movement of money.

Transaction Requests are requests to move money which may or may not succeeed and thus result in a Transaction.

A Transaction Request might create a security challenge that needs to be answered before the Transaction Request proceeds.

Transaction Requests contain charge information giving the client the opportunity to proceed or not (as long as the challenge level is appropriate).

Transaction Requests can have one of several Transaction Request Types which expect different bodies. The escaped body is returned in the details key of the GET response. This provides some commonality and one URL for many different payment or transfer types with enough flexibility to validate them differently.

The payer is set in the URL. Money comes out of the BANK_ID and ACCOUNT_ID specified in the URL.

In sandbox mode, TRANSACTION_REQUEST_TYPE is commonly set to SANDBOX_TAN. See getTransactionRequestTypesSupportedByBank for all supported types.

In sandbox mode, if the amount is less than 1000 EUR (any currency, unless it is set differently on this server), the transaction request will create a transaction without a challenge, else the Transaction Request will be set to INITIALISED and a challenge will need to be answered.

If a challenge is created you must answer it using Answer Transaction Request Challenge before the Transaction is created.

You can transfer between different currency accounts. (new in 2.0.0). The currency in body must match the sending account.

The following static FX rates are available in sandbox mode:

{ "XAF":{ "AUD":1.0, "KRW":1.87975, "JOD":1.0, "GBP":0.00131092, "AED":0.00601555, "INR":0.110241, "JPY":0.185328, "USD":0.00163773, "EUR":0.00152449 }, "AUD":{ "XAF":762.826, "KRW":1433.92, "JOD":1.0, "AED":4.58882, "INR":84.095, "JPY":141.373, "USD":0.79, "EUR":0.67 }, "KRW":{ "XAF":0.531986, "AUD":1.0, "JOD":1.0, "GBP":6.97389E-4, "AED":0.00320019, "INR":0.0586469, "JPY":0.0985917, "USD":8.7125E-4, "EUR":8.11008E-4 }, "JOD":{ "XAF":1.0, "AUD":1.0, "KRW":1.0, "GBP":1.0, "AED":1.0, "INR":1.0, "JPY":1.0, "USD":1.0, "EUR":1.0 }, "GBP":{ "XAF":762.826, "AUD":1.0, "KRW":1433.92, "JOD":1.0, "AED":4.58882, "INR":84.095, "JPY":141.373, "USD":1.2493, "EUR":1.16278 }, "AED":{ "XAF":166.236, "AUD":1.0, "KRW":312.482, "GBP":0.217921, "AED":1.0, "INR":18.3255, "JPY":30.8081, "USD":0.27225, "EUR":0.253425 }, "INR":{ "XAF":9.07101, "AUD":1.0, "KRW":17.0512, "JOD":1.0, "GBP":0.0118913, "AED":0.0545671, "JPY":1.68111, "USD":0.0148559, "EUR":0.0138287 }, "JPY":{ "XAF":5.39585, "AUD":1.0, "KRW":10.1428, "JOD":1.0, "GBP":0.0070735, "AED":0.032459, "INR":0.594846, "USD":0.00883695, "EUR":0.00822592 }, "USD":{ "XAF":610.601, "AUD":1.0, "KRW":1147.78, "JOD":1.0, "GBP":0.800446, "AED":3.6731, "INR":67.3135, "JPY":113.161, "EUR":0.930886 }, "EUR":{ "XAF":655.957, "AUD":1.0, "KRW":1233.03, "JOD":1.0, "GBP":0.860011, "AED":3.94594, "INR":72.3136, "JPY":121.567, "USD":1.07428 } }

Transaction Requests satisfy PSD2 requirements thus:

1) A transaction can be initiated by a third party application.

2) The customer is informed of the charge that will incurred.

3) The call supports delegated authentication (OAuth)

See this python code for a complete example of this flow.

There is further documentation here

Authentication is Mandatory

Typical Successful Response:

                            
                                
{ "id":"4050046c-63b3-4868-8a22-14b4181d33a6", "type":"SANDBOX_TAN", "from":{ "bank_id":"gh.29.uk", "account_id":"8ca8a7e4-6d02-48e3-a029-0b2bf89de9f0" }, "details":[], "transaction_ids":["902ba3bb-dedd-45e7-9319-2fd3f2cd98a1"], "status":"COMPLETED", "start_date":"2013-01-22T00:08:00Z", "end_date":"2013-01-22T00:08:00Z", "challenge":{ "id":"be1a183d-b301-4b83-b855-5eeffdd3526f", "allowed_attempts":3, "challenge_type":"SANDBOX_TAN" }, "charge":{ "summary":"Good", "value":{ "currency":"EUR", "amount":"10" } } }
Possible Errors:
  • OBP-20001: User not logged in. Authentication is required!
  • OBP-20001: User not logged in. Authentication is required!
  • 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-30110: Invalid Account Id. The ACCOUNT_ID should only contain 0-9/a-z/A-Z/'-'/'.'/'_', the length should be smaller than 255.
  • 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-30005: View not found for Account. Please specify a valid value for VIEW_ID
  • OBP-40002: Insufficient authorisation to create TransactionRequest. The Transaction Request could not be created because you don't have access to the owner view of the from account or you don't have access to canCreateAnyTransactionRequest.
  • OBP-20017: Current user does not have access to the view. Please specify a valid value for VIEW_ID.
  • OBP-40001: Invalid value for TRANSACTION_REQUEST_TYPE
  • OBP-10001: Incorrect json format.
  • 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-00003: Transaction Requests is disabled in this API instance.
  • OBP-50000: Unknown Error.
Implmented in 2_1_0 by createTransactionRequestSandboxTan

Create Transaction Request (SEPA)

Special instructions for SEPA:

When using a SEPA Transaction Request, you specify the IBAN of a Counterparty in the body of the request. The routing details (IBAN) of the counterparty will be forwarded to the core banking system for the transfer.

Initiate a Payment via creating a Transaction Request.

In OBP, a transaction request may or may not result in a transaction. However, a transaction only has one possible state: completed.

A Transaction Request can have one of several states.

Transactions are modeled on items in a bank statement that represent the movement of money.

Transaction Requests are requests to move money which may or may not succeeed and thus result in a Transaction.

A Transaction Request might create a security challenge that needs to be answered before the Transaction Request proceeds.

Transaction Requests contain charge information giving the client the opportunity to proceed or not (as long as the challenge level is appropriate).

Transaction Requests can have one of several Transaction Request Types which expect different bodies. The escaped body is returned in the details key of the GET response. This provides some commonality and one URL for many different payment or transfer types with enough flexibility to validate them differently.

The payer is set in the URL. Money comes out of the BANK_ID and ACCOUNT_ID specified in the URL.

In sandbox mode, TRANSACTION_REQUEST_TYPE is commonly set to SANDBOX_TAN. See getTransactionRequestTypesSupportedByBank for all supported types.

In sandbox mode, if the amount is less than 1000 EUR (any currency, unless it is set differently on this server), the transaction request will create a transaction without a challenge, else the Transaction Request will be set to INITIALISED and a challenge will need to be answered.

If a challenge is created you must answer it using Answer Transaction Request Challenge before the Transaction is created.

You can transfer between different currency accounts. (new in 2.0.0). The currency in body must match the sending account.

The following static FX rates are available in sandbox mode:

{ "XAF":{ "AUD":1.0, "KRW":1.87975, "JOD":1.0, "GBP":0.00131092, "AED":0.00601555, "INR":0.110241, "JPY":0.185328, "USD":0.00163773, "EUR":0.00152449 }, "AUD":{ "XAF":762.826, "KRW":1433.92, "JOD":1.0, "AED":4.58882, "INR":84.095, "JPY":141.373, "USD":0.79, "EUR":0.67 }, "KRW":{ "XAF":0.531986, "AUD":1.0, "JOD":1.0, "GBP":6.97389E-4, "AED":0.00320019, "INR":0.0586469, "JPY":0.0985917, "USD":8.7125E-4, "EUR":8.11008E-4 }, "JOD":{ "XAF":1.0, "AUD":1.0, "KRW":1.0, "GBP":1.0, "AED":1.0, "INR":1.0, "JPY":1.0, "USD":1.0, "EUR":1.0 }, "GBP":{ "XAF":762.826, "AUD":1.0, "KRW":1433.92, "JOD":1.0, "AED":4.58882, "INR":84.095, "JPY":141.373, "USD":1.2493, "EUR":1.16278 }, "AED":{ "XAF":166.236, "AUD":1.0, "KRW":312.482, "GBP":0.217921, "AED":1.0, "INR":18.3255, "JPY":30.8081, "USD":0.27225, "EUR":0.253425 }, "INR":{ "XAF":9.07101, "AUD":1.0, "KRW":17.0512, "JOD":1.0, "GBP":0.0118913, "AED":0.0545671, "JPY":1.68111, "USD":0.0148559, "EUR":0.0138287 }, "JPY":{ "XAF":5.39585, "AUD":1.0, "KRW":10.1428, "JOD":1.0, "GBP":0.0070735, "AED":0.032459, "INR":0.594846, "USD":0.00883695, "EUR":0.00822592 }, "USD":{ "XAF":610.601, "AUD":1.0, "KRW":1147.78, "JOD":1.0, "GBP":0.800446, "AED":3.6731, "INR":67.3135, "JPY":113.161, "EUR":0.930886 }, "EUR":{ "XAF":655.957, "AUD":1.0, "KRW":1233.03, "JOD":1.0, "GBP":0.860011, "AED":3.94594, "INR":72.3136, "JPY":121.567, "USD":1.07428 } }

Transaction Requests satisfy PSD2 requirements thus:

1) A transaction can be initiated by a third party application.

2) The customer is informed of the charge that will incurred.

3) The call supports delegated authentication (OAuth)

See this python code for a complete example of this flow.

There is further documentation here

Authentication is Mandatory

Typical Successful Response:

                            
                                
{ "id":"4050046c-63b3-4868-8a22-14b4181d33a6", "type":"SANDBOX_TAN", "from":{ "bank_id":"gh.29.uk", "account_id":"8ca8a7e4-6d02-48e3-a029-0b2bf89de9f0" }, "details":[], "transaction_ids":["902ba3bb-dedd-45e7-9319-2fd3f2cd98a1"], "status":"COMPLETED", "start_date":"2013-01-22T00:08:00Z", "end_date":"2013-01-22T00:08:00Z", "challenge":{ "id":"be1a183d-b301-4b83-b855-5eeffdd3526f", "allowed_attempts":3, "challenge_type":"SANDBOX_TAN" }, "charge":{ "summary":"Good", "value":{ "currency":"EUR", "amount":"10" } } }
Possible Errors:
  • OBP-20001: User not logged in. Authentication is required!
  • OBP-20001: User not logged in. Authentication is required!
  • 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-30110: Invalid Account Id. The ACCOUNT_ID should only contain 0-9/a-z/A-Z/'-'/'.'/'_', the length should be smaller than 255.
  • 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-30005: View not found for Account. Please specify a valid value for VIEW_ID
  • OBP-40002: Insufficient authorisation to create TransactionRequest. The Transaction Request could not be created because you don't have access to the owner view of the from account or you don't have access to canCreateAnyTransactionRequest.
  • OBP-20017: Current user does not have access to the view. Please specify a valid value for VIEW_ID.
  • OBP-40001: Invalid value for TRANSACTION_REQUEST_TYPE
  • OBP-10001: Incorrect json format.
  • 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-00003: Transaction Requests is disabled in this API instance.
  • OBP-50000: Unknown Error.
Implmented in 2_1_0 by createTransactionRequestSepa

Get Transaction Request Types for Account

Returns the Transation Request Types that the account specified by ACCOUNT_ID and view specified by VIEW_ID has access to.

These are the ways this API Server can create a Transaction via a Transaction Request (as opposed to Transaction Types which include external types too e.g. for Transactions created by core banking etc.)

A Transaction Request Type internally determines:

  • the required Transaction Request 'body' i.e. fields that define the 'what' and 'to' of a Transaction Request,
  • the type of security challenge that may be be raised before the Transaction Request proceeds, and
  • the threshold of that challenge.

For instance in a 'SANDBOX_TAN' Transaction Request, for amounts over 1000 currency units, the user must supply a positive integer to complete the Transaction Request and create a Transaction.

This approach aims to provide only one endpoint for initiating transactions, and one that handles challenges, whilst still allowing flexibility with the payload and internal logic.

Typical Successful Response:

                            
                                
{ "transaction_request_types":[{ "value":"10", "charge":{ "summary":"Good", "value":{ "currency":"EUR", "amount":"10" } } }] }
Possible Errors:
  • OBP-20001: User not logged in. Authentication is required!
  • OBP-30001: Bank not found. Please specify a valid value for BANK_ID.
  • OBP-30003: Account not found. Please specify a valid value for ACCOUNT_ID.
  • Please specify a valid value for CURRENCY of your Bank Account.
  • Current user does not have access to the view
  • account not found at bank
  • user does not have access to owner view
  • Sorry, Transaction Requests are not enabled in this API instance.
  • OBP-50000: Unknown Error.
Implmented in 1_4_0 by getTransactionRequestTypes

Get Transaction Requests.

Returns transaction requests for account specified by ACCOUNT_ID at bank specified by BANK_ID.

The VIEW_ID specified must be 'owner' and the user must have access to this view.

Version 2.0.0 now returns charge information.

Transaction Requests serve to initiate transactions that may or may not proceed. They contain information including:

  • Transaction Request Id
  • Type
  • Status (INITIATED, COMPLETED)
  • Challenge (in order to confirm the request)
  • From Bank / Account
  • Details including Currency, Value, Description and other initiation information specific to each type. (Could potentialy include a list of future transactions.)
  • Related Transactions

PSD2 Context: PSD2 requires transparency of charges to the customer. This endpoint provides the charge that would be applied if the Transaction Request proceeds - and a record of that charge there after. The customer can proceed with the Transaction by answering the security challenge.

Typical Successful Response:

                            
                                
{ "transaction_requests_with_charges":[{ "id":"4050046c-63b3-4868-8a22-14b4181d33a6", "type":"SANDBOX_TAN", "from":{ "bank_id":"gh.29.uk", "account_id":"8ca8a7e4-6d02-48e3-a029-0b2bf89de9f0" }, "details":[], "transaction_ids":["902ba3bb-dedd-45e7-9319-2fd3f2cd98a1"], "status":"COMPLETED", "start_date":"2013-01-22T00:08:00Z", "end_date":"2013-01-22T00:08:00Z", "challenge":{ "id":"be1a183d-b301-4b83-b855-5eeffdd3526f", "allowed_attempts":3, "challenge_type":"SANDBOX_TAN" }, "charge":{ "summary":"Good", "value":{ "currency":"EUR", "amount":"10" } } }] }
Possible Errors:
  • OBP-20001: User not logged in. Authentication is required!
  • OBP-30001: Bank not found. Please specify a valid value for BANK_ID.
  • OBP-30003: Account not found. Please specify a valid value for ACCOUNT_ID.
  • OBP-20006: User is missing one or more roles:
  • OBP-50000: Unknown Error.
Implmented in 2_1_0 by getTransactionRequests

Get Entitlements specified by BANK_ID and USER_ID

Login is required.

Typical Successful Response:

                            
                                
{ "list":[{ "entitlement_id":"6fb17583-1e49-4435-bb74-a14fe0996723", "role_name":"CanQueryOtherUser", "bank_id":"gh.29.uk" }] }
Possible Errors:
  • OBP-20001: User not logged in. Authentication is required!
  • OBP-20006: User is missing one or more roles:
  • OBP-50000: Unknown Error.
Implmented in 2_1_0 by getEntitlementsByBankAndUser

Get Roles

Returns all available roles

Login is required.

Typical Successful Response:

                            
                                
{ "roles":[{ "role":"CanCreateBranch", "requires_bank_id":true }] }
Possible Errors:
  • OBP-20001: User not logged in. Authentication is required!
  • OBP-50000: Unknown Error.
Implmented in 2_1_0 by getRoles