API Explorer

⯆

API Explorer

My Collections

v5.1.0 (606 APIs)

API Host: https://apisandbox.openbankproject.com

Answer Transaction Request Challenge

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

This endpoint totally depends on createTransactionRequest, it need get the following data from createTransactionRequest response body.

1)TRANSACTION_REQUEST_TYPE : is the same as createTransactionRequest request URL .

2)TRANSACTION_REQUEST_ID : is the id field in createTransactionRequest response body.

3) id : is challenge.id field in createTransactionRequest response body.

4) answer : must be 123 in case that Strong Customer Authentication method for OTP challenge is dummy.
For instance: SANDBOX_TAN_OTP_INSTRUCTION_TRANSPORT=dummy
Possible values are dummy,email and sms
In kafka mode, the answer can be got by phone message or other SCA methods.

Note that each Transaction Request Type can have its own OTP_INSTRUCTION_TRANSPORT method.
OTP_INSTRUCTION_TRANSPORT methods are set in Props. See sample.props.template for instructions.

Single or Multiple authorisations

OBP allows single or multi party authorisations.

Single party authorisation:

In the case that only one person needs to authorise i.e. answer a security challenge we have the following change of state of a transaction request:
INITIATED => COMPLETED

Multiparty authorisation:

In the case that multiple parties (n persons) need to authorise a transaction request i.e. answer security challenges, we have the followings state flow for a transaction request:
INITIATED => NEXT_CHALLENGE_PENDING => ... => NEXT_CHALLENGE_PENDING => COMPLETED

The security challenge is bound to a user i.e. in the case of a correct answer but the user is different than expected the challenge will fail.

Rule for calculating number of security challenges:
If Product Account attribute REQUIRED_CHALLENGE_ANSWERS=N then create N challenges
(one for every user that has a View where permission "can_add_transaction_request_to_any_account"=true)
In the case REQUIRED_CHALLENGE_ANSWERS is not defined as an account attribute, the default number of security challenges created is one.

Authentication is Mandatory

URL Parameters:

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

BANK_ID: gh.29.uk

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

TRANSACTION_REQUEST_TYPE: SEPA

VIEW_ID: owner

JSON request body fields:

answer:

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

additional_information: additional_information

reason_code: reason_code

JSON response body fields:

account:

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

allowed_attempts: 5

amount: 10.12

bank_code: CGHZ

bank_id: gh.29.uk

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

creditorAccount:

creditorName:

currency: EUR

date_of_birth: 2018-03-09

debtorAccount:

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

details:

end_date:

from:

future_date: 20200127

iban: DE91 1000 0000 0123 4567 89

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

instructedAmount: 100

kyc_document:

legal_name: Eveline Tripman

message: 123456

mobile_phone_number: +49 30 901820

name: ACCOUNT_MANAGEMENT_FEE

nickname:

number:

otherAccountRoutingAddress: otherAccountRoutingAddress

otherAccountRoutingScheme: otherAccountRoutingScheme

otherAccountSecondaryRoutingAddress: otherAccountSecondaryRoutingAddress

otherAccountSecondaryRoutingScheme: otherAccountSecondaryRoutingScheme

otherBankRoutingAddress: otherBankRoutingAddress

otherBankRoutingScheme: otherBankRoutingScheme

otherBranchRoutingAddress: otherBranchRoutingAddress

otherBranchRoutingScheme: otherBranchRoutingScheme

start_date: 2020-01-27

to:

value: 5987953

to_sepa_credit_transfers:

to_simple: to_simple

to_transfer_to_account:

to_transfer_to_atm:

to_transfer_to_phone:

Typical Successful Response:

								
									{
  "id":"4050046c-63b3-4868-8a22-14b4181d33a6",
  "type":"SANDBOX_TAN",
  "from":{
    "bank_id":"gh.29.uk",
    "account_id":"8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0"
  },
  "details":{
    "to_sandbox_tan":{
      "bank_id":"String",
      "account_id":"String"
    },
    "to_sepa":{
      "iban":"String"
    },
    "to_counterparty":{
      "counterparty_id":"9fg8a7e4-6d02-40e3-a129-0b2bf89de8uh"
    },
    "to_simple":{
      "otherBankRoutingScheme":"BIC",
      "otherBankRoutingAddress":"GENODEM1GLS",
      "otherBranchRoutingScheme":"BRANCH-CODE",
      "otherBranchRoutingAddress":"DERBY6",
      "otherAccountRoutingScheme":"IBAN",
      "otherAccountRoutingAddress":"DE91 1000 0000 0123 4567 89",
      "otherAccountSecondaryRoutingScheme":"IBAN",
      "otherAccountSecondaryRoutingAddress":"DE91 1000 0000 0123 4567 89"
    },
    "to_transfer_to_phone":{
      "value":{
        "currency":"EUR",
        "amount":"0"
      },
      "description":"String",
      "message":"String",
      "from":{
        "mobile_phone_number":"+44 07972 444 876",
        "nickname":"String"
      },
      "to":{
        "mobile_phone_number":"+44 07972 444 876"
      }
    },
    "to_transfer_to_atm":{
      "value":{
        "currency":"EUR",
        "amount":"0"
      },
      "description":"String",
      "message":"String",
      "from":{
        "mobile_phone_number":"+44 07972 444 876",
        "nickname":"String"
      },
      "to":{
        "legal_name":"Eveline Tripman",
        "date_of_birth":"20181230",
        "mobile_phone_number":"+44 07972 444 876",
        "kyc_document":{
          "type":"String",
          "number":"String"
        }
      }
    },
    "to_transfer_to_account":{
      "value":{
        "currency":"EUR",
        "amount":"0"
      },
      "description":"String",
      "transfer_type":"String",
      "future_date":"20181230",
      "to":{
        "name":"String",
        "bank_code":"String",
        "branch_number":"String",
        "account":{
          "number":"String",
          "iban":"String"
        }
      }
    },
    "to_sepa_credit_transfers":{
      "debtorAccount":{
        "iban":"12345"
      },
      "instructedAmount":{
        "currency":"EUR",
        "amount":"0"
      },
      "creditorAccount":{
        "iban":"54321"
      },
      "creditorName":"John Miles"
    },
    "value":{
      "currency":"EUR",
      "amount":"100"
    },
    "description":"This an optional field. Maximum length is 2000. It can be any characters here."
  },
  "transaction_ids":["902ba3bb-dedd-45e7-9319-2fd3f2cd98a1"],
  "status":"COMPLETED",
  "start_date":"1100-01-01T00:00:00Z",
  "end_date":"1100-01-01T00:00:00Z",
  "challenge":{
    "id":"be1a183d-b301-4b83-b855-5eeffdd3526f",
    "allowed_attempts":3,
    "challenge_type":"SANDBOX_TAN"
  },
  "charge":{
    "summary":"Rent the flat",
    "value":{
      "currency":"EUR",
      "amount":"0"
    }
  }
}

Request Headers:

Response Headers:

Required Roles:

Validations:

Required JSON Validation: No
Allowed Authentication Types: Not set

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-30018: Bank Account not found. Please specify valid values for BANK_ID and ACCOUNT_ID.
OBP-40011: Transaction Request Status is not INITIATED.
OBP-40009: The TRANSACTION_REQUEST_TYPE has changed.
OBP-40014: Sorry, you've used up your allowed attempts.
OBP-00003: Transaction Requests is disabled in this API instance.
OBP-50000: Unknown Error.

Connector Methods:

Version: OBPv4.0.0, function_name: by answerTransactionRequestChallenge, operation_id: OBPv4.0.0-answerTransactionRequestChallenge Tags: Transaction-Request, Payment Initiation Service (PIS), PSD2,

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

Typical Successful Response:

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

Request Headers:

Response Headers:

Required Roles:

CanCreateHistoricalTransactionAtBank - Please login to request this Role

Validations:

Required JSON Validation: No
Allowed Authentication Types: Not set

Possible Errors:

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:

Connector Methods:

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

Create Transaction Request (ACCOUNT)

When using ACCOUNT, 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: INITIATED, NEXT_CHALLENGE_PENDING etc.

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 succeed and thus result in a Transaction.

A Transaction Request might create a security challenge that needs to be answered before the Transaction Request proceeds.
In case 1 person needs to answer security challenge we have next flow of state of an transaction request:
INITIATED => COMPLETED
In case n persons needs to answer security challenge we have next flow of state of an transaction request:
INITIATED => NEXT_CHALLENGE_PENDING => ... => NEXT_CHALLENGE_PENDING => COMPLETED

The security challenge is bound to a user i.e. in case of right answer and the user is different than expected one the challenge will fail.

Rule for calculating number of security challenges:
If product Account attribute REQUIRED_CHALLENGE_ANSWERS=N then create N challenges
(one for every user that has a View where permission "can_add_transaction_request_to_any_account"=true)
In case REQUIRED_CHALLENGE_ANSWERS is not defined as an account attribute default value is 1.

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 ACCOUNT. 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:

https://apiexplorer-ii-sandbox.openbankproject.com//more?version=OBPv4.0.0&list-all-banks=false&core=&psd2=&obwg=#OBPv2_2_0-getCurrentFxRate

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

URL Parameters:

ACCOUNT:

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

BANK_ID: gh.29.uk

VIEW_ID: owner

JSON request body fields:

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

amount: 10.12

bank_id: gh.29.uk

currency: EUR

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

to:

value: 5987953

JSON response body fields:

account:

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

allowed_attempts: 5

amount: 10.12

bank_code: CGHZ

bank_id: gh.29.uk

branch_number:

challenge_type:

challenges: challenges

charge:

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

creditorAccount:

creditorName:

currency: EUR

date_of_birth: 2018-03-09

debtorAccount:

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

details:

end_date:

from:

future_date: 20200127

iban: DE91 1000 0000 0123 4567 89

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

instructedAmount: 100

kyc_document:

legal_name: Eveline Tripman

link:

message: 123456

mobile_phone_number: +49 30 901820

name: ACCOUNT_MANAGEMENT_FEE

nickname:

number:

otherAccountRoutingAddress: otherAccountRoutingAddress

otherAccountRoutingScheme: otherAccountRoutingScheme

otherAccountSecondaryRoutingAddress: otherAccountSecondaryRoutingAddress

otherAccountSecondaryRoutingScheme: otherAccountSecondaryRoutingScheme

otherBankRoutingAddress: otherBankRoutingAddress

otherBankRoutingScheme: otherBankRoutingScheme

otherBranchRoutingAddress: otherBranchRoutingAddress

otherBranchRoutingScheme: otherBranchRoutingScheme

start_date: 2020-01-27

to:

user_id: 9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1

value: 5987953

to_counterparty:

to_sandbox_tan:

to_sepa:

to_sepa_credit_transfers:

to_simple: to_simple

to_transfer_to_account:

to_transfer_to_atm:

to_transfer_to_phone:

Typical Successful Response:

								
									{
  "id":"4050046c-63b3-4868-8a22-14b4181d33a6",
  "type":"SANDBOX_TAN",
  "from":{
    "bank_id":"gh.29.uk",
    "account_id":"8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0"
  },
  "details":{
    "to_sandbox_tan":{
      "bank_id":"String",
      "account_id":"String"
    },
    "to_sepa":{
      "iban":"String"
    },
    "to_counterparty":{
      "counterparty_id":"9fg8a7e4-6d02-40e3-a129-0b2bf89de8uh"
    },
    "to_simple":{
      "otherBankRoutingScheme":"BIC",
      "otherBankRoutingAddress":"GENODEM1GLS",
      "otherBranchRoutingScheme":"BRANCH-CODE",
      "otherBranchRoutingAddress":"DERBY6",
      "otherAccountRoutingScheme":"IBAN",
      "otherAccountRoutingAddress":"DE91 1000 0000 0123 4567 89",
      "otherAccountSecondaryRoutingScheme":"IBAN",
      "otherAccountSecondaryRoutingAddress":"DE91 1000 0000 0123 4567 89"
    },
    "to_transfer_to_phone":{
      "value":{
        "currency":"EUR",
        "amount":"0"
      },
      "description":"String",
      "message":"String",
      "from":{
        "mobile_phone_number":"+44 07972 444 876",
        "nickname":"String"
      },
      "to":{
        "mobile_phone_number":"+44 07972 444 876"
      }
    },
    "to_transfer_to_atm":{
      "value":{
        "currency":"EUR",
        "amount":"0"
      },
      "description":"String",
      "message":"String",
      "from":{
        "mobile_phone_number":"+44 07972 444 876",
        "nickname":"String"
      },
      "to":{
        "legal_name":"Eveline Tripman",
        "date_of_birth":"20181230",
        "mobile_phone_number":"+44 07972 444 876",
        "kyc_document":{
          "type":"String",
          "number":"String"
        }
      }
    },
    "to_transfer_to_account":{
      "value":{
        "currency":"EUR",
        "amount":"0"
      },
      "description":"String",
      "transfer_type":"String",
      "future_date":"20181230",
      "to":{
        "name":"String",
        "bank_code":"String",
        "branch_number":"String",
        "account":{
          "number":"String",
          "iban":"String"
        }
      }
    },
    "to_sepa_credit_transfers":{
      "debtorAccount":{
        "iban":"12345"
      },
      "instructedAmount":{
        "currency":"EUR",
        "amount":"0"
      },
      "creditorAccount":{
        "iban":"54321"
      },
      "creditorName":"John Miles"
    },
    "value":{
      "currency":"EUR",
      "amount":"100"
    },
    "description":"This an optional field. Maximum length is 2000. It can be any characters here."
  },
  "transaction_ids":["902ba3bb-dedd-45e7-9319-2fd3f2cd98a1"],
  "status":"COMPLETED",
  "start_date":"1100-01-01T00:00:00Z",
  "end_date":"1100-01-01T00:00:00Z",
  "challenges":[{
    "id":"2fg8a7e4-6d02-40e3-a129-0b2bf89de8ub",
    "user_id":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1",
    "allowed_attempts":3,
    "challenge_type":"OBP_TRANSACTION_REQUEST_CHALLENGE",
    "link":"/obp/v4.0.0/banks/BANK_ID/accounts/ACCOUNT_ID/VIEW_ID/transaction-request-types/TRANSACTION_REQUEST_TYPE/transaction-requests/TRANSACTION_REQUEST_ID/challenge"
  }],
  "charge":{
    "summary":"Rent the flat",
    "value":{
      "currency":"EUR",
      "amount":"0"
    }
  }
}

Request Headers:

Response Headers:

Required Roles:

Validations:

Required JSON Validation: No
Allowed Authentication Types: Not set

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-30003: Account not found. Please specify a valid value for ACCOUNT_ID.
OBP-30018: Bank Account not found. Please specify valid values for BANK_ID and ACCOUNT_ID.
OBP-40002: Insufficient authorisation to create TransactionRequest. The Transaction Request could not be created because the login user doesn't have access to the view of the from account or the consumer doesn't have the access to the view of the from account or the login user does not have the `CanCreateAnyTransactionRequest` role or the view does not have the permission can_add_transaction_request_to_any_account or the view does not have the permission can_add_transaction_request_to_beneficiary.
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.

Connector Methods:

Version: OBPv4.0.0, function_name: by createTransactionRequestAccount, operation_id: OBPv4.0.0-createTransactionRequestAccount Tags: Transaction-Request, Payment Initiation Service (PIS), PSD2,

Create Transaction Request (ACCOUNT_OTP)