{"swagger":"2.0","info":{"title":"Open Bank Project API","description":"An Open Source API for Banks. (c) TESOBE GmbH. 2011 - 2026. Licensed under the AGPL and commercial licences.","contact":{"name":"TESOBE GmbH. / Open Bank Project","url":"https://openbankproject.com","email":"contact@tesobe.com"},"version":"v5.1.0"},"host":"obp-api-sandbox.nmbbank.co.tz","basePath":"/","schemes":["http","https"],"securityDefinitions":{"directLogin":{"type":"apiKey","description":"Direct Login authentication. POST to /obp/v6.0.0/my/logins/direct with header 'DirectLogin: username=YOUR_USERNAME, password=YOUR_PASSWORD, consumer_key=YOUR_CONSUMER_KEY' to obtain a token. Then use header 'DirectLogin: token=YOUR_TOKEN' on subsequent requests. See the OpenAPI 3.1 spec for full details.","in":"header","name":"DirectLogin"},"gatewayLogin":{"type":"apiKey","description":"Gateway Login authentication. The gateway sends a JWT in the Authorization header signed with a pre-shared secret. See the OpenAPI 3.1 spec for full details.","in":"header","name":"Authorization"}},"security":[{"directLogin":[],"gatewayLogin":[]}],"paths":{"/obp/v5.1.0/banks/{BANK_ID}/accounts/{ACCOUNT_ID}/GRANT_VIEW_ID/transaction-request-types/ACCOUNT_OTP/transaction-requests":{"post":{"tags":["Transaction-Request","Payment Initiation Service (PIS)","PSD2"],"summary":"Create Transaction Request (ACCOUNT_OTP)","security":[{"directLogin":[],"gatewayLogin":[]}],"description":"

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.

For an introduction to Transaction Requests, see: here

User Authentication is Required. The User must be logged in. The Application must also be authenticated.

URL Parameters:

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

ACCOUNT_OTP:

BANK_ID: gh.29.uk

GRANT_VIEW_ID: GRANT_VIEW_ID

JSON request body fields:

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

amount: 10.12

bank_id: gh.29.uk

currency: EUR

description: Description of the object. 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

agent_number: 5987953

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: Description of the object. 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

status:

summary:

to:

transaction_ids:

transfer_type:

type:

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

value: 5987953

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

to_agent: to_agent

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:

","operationId":"OBPv4.0.0-createTransactionRequestAccountOtp","parameters":[{"in":"body","name":"body","description":"TransactionRequestBodyJsonV200 object that needs to be added.","required":true,"schema":{"$ref":"#/definitions/TransactionRequestBodyJsonV200"}},{"in":"path","name":"ACCOUNT_ID","description":"The account id","required":true,"type":"string"},{"in":"path","name":"BANK_ID","description":"The bank id","required":true,"type":"string"}],"responses":{"201":{"description":"Success","schema":{"$ref":"#/definitions/TransactionRequestWithChargeJSON400"}},"400":{"description":"Error","schema":{"$ref":"#/definitions/ErrorAuthenticatedUserIsRequired"}}}}},"/obp/v5.1.0/banks/{BANK_ID}/accounts/{ACCOUNT_ID}/GRANT_VIEW_ID/transaction-request-types/AGENT_CASH_WITHDRAWAL/transaction-requests":{"post":{"tags":["Transaction-Request","Payment Initiation Service (PIS)","PSD2"],"summary":"Create Transaction Request (AGENT_CASH_WITHDRAWAL)","security":[{"directLogin":[],"gatewayLogin":[]}],"description":"

Either the from or the to field must be filled. Those fields refers to the information about the party that will be refunded.

In case the from object is used, it means that the refund comes from the part that sent you a transaction.
In the from object, you have two choices :
- Use bank_id and account_id fields if the other account is registered on the OBP-API
- Use the counterparty_id field in case the counterparty account is out of the OBP-API

In case the to object is used, it means you send a request to a counterparty to ask for a refund on a previous transaction you sent.
(This case is not managed by the OBP-API and require an external adapter)

For an introduction to Transaction Requests, see: here

User Authentication is Required. The User must be logged in. The Application must also be authenticated.

URL Parameters:

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

AGENT_CASH_WITHDRAWAL: AGENT_CASH_WITHDRAWAL

BANK_ID: gh.29.uk

GRANT_VIEW_ID: GRANT_VIEW_ID

JSON request body fields:

agent_number: 5987953

amount: 10.12

bank_id: gh.29.uk

charge_policy: SHARED

currency: EUR

description: Description of the object. Maximum length is 2000. It can be any characters here.

to:

value: 5987953

future_date: 20200127

JSON response body fields:

account:

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

agent_number: 5987953

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: Description of the object. 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

status:

summary:

to:

transaction_ids:

transfer_type:

type:

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

value: 5987953

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

to_agent: to_agent

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:

","operationId":"OBPv4.0.0-createTransactionRequestAgentCashWithDrawal","parameters":[{"in":"body","name":"body","description":"TransactionRequestBodyAgentJsonV400 object that needs to be added.","required":true,"schema":{"$ref":"#/definitions/TransactionRequestBodyAgentJsonV400"}},{"in":"path","name":"ACCOUNT_ID","description":"The account id","required":true,"type":"string"},{"in":"path","name":"BANK_ID","description":"The bank id","required":true,"type":"string"}],"responses":{"201":{"description":"Success","schema":{"$ref":"#/definitions/TransactionRequestWithChargeJSON400"}},"400":{"description":"Error","schema":{"$ref":"#/definitions/ErrorAuthenticatedUserIsRequired"}}}}},"/obp/v5.1.0/banks/{BANK_ID}/accounts/{ACCOUNT_ID}/GRANT_VIEW_ID/transaction-request-types/COUNTERPARTY/transaction-requests":{"post":{"tags":["Transaction-Request","Payment Initiation Service (PIS)","PSD2"],"summary":"Create Transaction Request (COUNTERPARTY)","security":[{"directLogin":[],"gatewayLogin":[]}],"description":"

For an introduction to Transaction Requests, see: here

When using a COUNTERPARTY to create a Transaction Request, specify the counterparty_id in the body of the request.
The routing details of the counterparty will be forwarded to the Core Banking System (CBS) for the transfer.

COUNTERPARTY Transaction Requests are used for Variable Recurring Payments (VRP). Use the following endpoint to create a consent for VRPs.

For a general introduction to Counterparties in OBP, see here

User Authentication is Required. The User must be logged in. The Application must also be authenticated.

URL Parameters:

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

BANK_ID: gh.29.uk

COUNTERPARTY:

GRANT_VIEW_ID: GRANT_VIEW_ID

JSON request body fields:

amount: 10.12

attribute_type: STRING

charge_policy: SHARED

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

currency: EUR

description: Description of the object. Maximum length is 2000. It can be any characters here.

name: ACCOUNT_MANAGEMENT_FEE

to:

value: 5987953

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

future_date: 20200127

JSON response body fields:

account:

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

agent_number: 5987953

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: Description of the object. 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

status:

summary:

to:

transaction_ids:

transfer_type:

type:

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

value: 5987953

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

to_agent: to_agent

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:

","operationId":"OBPv4.0.0-createTransactionRequestCounterparty","parameters":[{"in":"body","name":"body","description":"TransactionRequestBodyCounterpartyJSON object that needs to be added.","required":true,"schema":{"$ref":"#/definitions/TransactionRequestBodyCounterpartyJSON"}},{"in":"path","name":"ACCOUNT_ID","description":"The account id","required":true,"type":"string"},{"in":"path","name":"BANK_ID","description":"The bank id","required":true,"type":"string"}],"responses":{"201":{"description":"Success","schema":{"$ref":"#/definitions/TransactionRequestWithChargeJSON400"}},"400":{"description":"Error","schema":{"$ref":"#/definitions/ErrorAuthenticatedUserIsRequired"}}}}},"/obp/v5.1.0/banks/{BANK_ID}/accounts/{ACCOUNT_ID}/GRANT_VIEW_ID/transaction-request-types/FREE_FORM/transaction-requests":{"post":{"tags":["Transaction-Request","Payment Initiation Service (PIS)"],"summary":"Create Transaction Request (FREE_FORM)","security":[{"directLogin":[],"gatewayLogin":[]}],"description":"

For an introduction to Transaction Requests, see: here

User Authentication is Required. The User must be logged in. The Application must also be authenticated.

URL Parameters:

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

BANK_ID: gh.29.uk

FREE_FORM:

GRANT_VIEW_ID: GRANT_VIEW_ID

JSON request body fields:

amount: 10.12

currency: EUR

description: Description of the object. Maximum length is 2000. It can be any characters here.

value: 5987953

JSON response body fields:

account:

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

agent_number: 5987953

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: Description of the object. 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

status:

summary:

to:

transaction_ids:

transfer_type:

type:

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

value: 5987953

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

to_agent: to_agent

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:

","operationId":"OBPv4.0.0-createTransactionRequestFreeForm","parameters":[{"in":"body","name":"body","description":"TransactionRequestBodyFreeFormJSON object that needs to be added.","required":true,"schema":{"$ref":"#/definitions/TransactionRequestBodyFreeFormJSON"}},{"in":"path","name":"ACCOUNT_ID","description":"The account id","required":true,"type":"string"},{"in":"path","name":"BANK_ID","description":"The bank id","required":true,"type":"string"}],"responses":{"201":{"description":"Success","schema":{"$ref":"#/definitions/TransactionRequestWithChargeJSON400"}},"400":{"description":"Error","schema":{"$ref":"#/definitions/ErrorAuthenticatedUserIsRequired"}}}}},"/obp/v5.1.0/banks/{BANK_ID}/accounts/{ACCOUNT_ID}/GRANT_VIEW_ID/transaction-request-types/REFUND/transaction-requests":{"post":{"tags":["Transaction-Request","Payment Initiation Service (PIS)","PSD2"],"summary":"Create Transaction Request (REFUND)","security":[{"directLogin":[],"gatewayLogin":[]}],"description":"

Either the from or the to field must be filled. Those fields refers to the information about the party that will be refunded.

In case the from object is used, it means that the refund comes from the part that sent you a transaction.
In the from object, you have two choices :
- Use bank_id and account_id fields if the other account is registered on the OBP-API
- Use the counterparty_id field in case the counterparty account is out of the OBP-API

In case the to object is used, it means you send a request to a counterparty to ask for a refund on a previous transaction you sent.
(This case is not managed by the OBP-API and require an external adapter)

For an introduction to Transaction Requests, see: here

User Authentication is Required. The User must be logged in. The Application must also be authenticated.

URL Parameters:

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

BANK_ID: gh.29.uk

GRANT_VIEW_ID: GRANT_VIEW_ID

REFUND: REFUND

JSON request body fields:

amount: 10.12

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

currency: EUR

description: Description of the object. Maximum length is 2000. It can be any characters here.

reason_code: reason_code

refund: refund

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

value: 5987953

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

bank_id: gh.29.uk

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

from:

to:

JSON response body fields:

account:

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

agent_number: 5987953

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: Description of the object. 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

status:

summary:

to:

transaction_ids:

transfer_type:

type:

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

value: 5987953

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

to_agent: to_agent

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:

","operationId":"OBPv4.0.0-createTransactionRequestRefund","parameters":[{"in":"body","name":"body","description":"TransactionRequestBodyRefundJsonV400 object that needs to be added.","required":true,"schema":{"$ref":"#/definitions/TransactionRequestBodyRefundJsonV400"}},{"in":"path","name":"ACCOUNT_ID","description":"The account id","required":true,"type":"string"},{"in":"path","name":"BANK_ID","description":"The bank id","required":true,"type":"string"}],"responses":{"201":{"description":"Success","schema":{"$ref":"#/definitions/TransactionRequestWithChargeJSON400"}},"400":{"description":"Error","schema":{"$ref":"#/definitions/ErrorAuthenticatedUserIsRequired"}}}}},"/obp/v5.1.0/banks/{BANK_ID}/accounts/{ACCOUNT_ID}/GRANT_VIEW_ID/transaction-request-types/SANDBOX_TAN/transaction-requests":{"post":{"tags":["Transaction-Request","Payment Initiation Service (PIS)","PSD2"],"summary":"Create Transaction Request (SANDBOX_TAN)","security":[{"directLogin":[],"gatewayLogin":[]}],"description":"

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

User Authentication is Required. The User must be logged in. The Application must also be authenticated.

URL Parameters:

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

BANK_ID: gh.29.uk

GRANT_VIEW_ID: GRANT_VIEW_ID

SANDBOX_TAN:

JSON request body fields:

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

amount: 10.12

bank_id: gh.29.uk

currency: EUR

description: Description of the object. 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

agent_number: 5987953

allowed_attempts: 5

amount: 10.12

bank_code: CGHZ

bank_id: gh.29.uk

branch_number:

challenge:

challenge_type:

charge:

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

creditorAccount:

creditorName:

currency: EUR

date_of_birth: 2018-03-09

debtorAccount:

description: Description of the object. 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

status:

summary:

to:

transaction_ids:

transfer_type:

type:

value: 5987953

to_agent: to_agent

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:

","operationId":"OBPv2.1.0-createTransactionRequestSandboxTan","parameters":[{"in":"body","name":"body","description":"TransactionRequestBodyJsonV200 object that needs to be added.","required":true,"schema":{"$ref":"#/definitions/TransactionRequestBodyJsonV200"}},{"in":"path","name":"ACCOUNT_ID","description":"The account id","required":true,"type":"string"},{"in":"path","name":"BANK_ID","description":"The bank id","required":true,"type":"string"}],"responses":{"201":{"description":"Success","schema":{"$ref":"#/definitions/TransactionRequestWithChargeJSON210"}},"400":{"description":"Error","schema":{"$ref":"#/definitions/ErrorAuthenticatedUserIsRequired"}}}}},"/obp/v5.1.0/banks/{BANK_ID}/accounts/{ACCOUNT_ID}/GRANT_VIEW_ID/transaction-request-types/SEPA/transaction-requests":{"post":{"tags":["Transaction-Request","Payment Initiation Service (PIS)","PSD2"],"summary":"Create Transaction Request (SEPA)","security":[{"directLogin":[],"gatewayLogin":[]}],"description":"

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.

For an introduction to Transaction Requests, see: here

User Authentication is Required. The User must be logged in. The Application must also be authenticated.

URL Parameters:

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

BANK_ID: gh.29.uk

GRANT_VIEW_ID: GRANT_VIEW_ID

SEPA:

JSON request body fields:

amount: 10.12

charge_policy: SHARED

code: 125

currency: EUR

description: Description of the object. Maximum length is 2000. It can be any characters here.

iban: DE91 1000 0000 0123 4567 89

to:

value: 5987953

amount: 10.12

currency: EUR

description: Description of the object. Maximum length is 2000. It can be any characters here.

document_number:

future_date: 20200127

reasons:

JSON response body fields:

account:

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

agent_number: 5987953

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: Description of the object. 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

status:

summary:

to:

transaction_ids:

transfer_type:

type:

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

value: 5987953

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

to_agent: to_agent

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:

","operationId":"OBPv4.0.0-createTransactionRequestSepa","parameters":[{"in":"body","name":"body","description":"TransactionRequestBodySEPAJsonV400 object that needs to be added.","required":true,"schema":{"$ref":"#/definitions/TransactionRequestBodySEPAJsonV400"}},{"in":"path","name":"ACCOUNT_ID","description":"The account id","required":true,"type":"string"},{"in":"path","name":"BANK_ID","description":"The bank id","required":true,"type":"string"}],"responses":{"201":{"description":"Success","schema":{"$ref":"#/definitions/TransactionRequestWithChargeJSON400"}},"400":{"description":"Error","schema":{"$ref":"#/definitions/ErrorAuthenticatedUserIsRequired"}}}}},"/obp/v5.1.0/banks/{BANK_ID}/accounts/{ACCOUNT_ID}/GRANT_VIEW_ID/transaction-request-types/SIMPLE/transaction-requests":{"post":{"tags":["Transaction-Request","Payment Initiation Service (PIS)","PSD2"],"summary":"Create Transaction Request (SIMPLE)","security":[{"directLogin":[],"gatewayLogin":[]}],"description":"

Special instructions for SIMPLE:

You can transfer money to the Bank Account Number or IBAN directly.

For an introduction to Transaction Requests, see: here

User Authentication is Required. The User must be logged in. The Application must also be authenticated.

URL Parameters:

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

BANK_ID: gh.29.uk

GRANT_VIEW_ID: GRANT_VIEW_ID

SIMPLE: SIMPLE

JSON request body fields:

amount: 10.12

charge_policy: SHARED

currency: EUR

description: Description of the object. Maximum length is 2000. It can be any characters here.

name: ACCOUNT_MANAGEMENT_FEE

other_account_routing_address: DE89370400440532013000

other_account_routing_scheme: IBAN

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:

to:

value: 5987953

future_date: 20200127

JSON response body fields:

account:

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

agent_number: 5987953

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: Description of the object. 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

status:

summary:

to:

transaction_ids:

transfer_type:

type:

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

value: 5987953

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

to_agent: to_agent

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:

","operationId":"OBPv4.0.0-createTransactionRequestSimple","parameters":[{"in":"body","name":"body","description":"TransactionRequestBodySimpleJsonV400 object that needs to be added.","required":true,"schema":{"$ref":"#/definitions/TransactionRequestBodySimpleJsonV400"}},{"in":"path","name":"ACCOUNT_ID","description":"The account id","required":true,"type":"string"},{"in":"path","name":"BANK_ID","description":"The bank id","required":true,"type":"string"}],"responses":{"201":{"description":"Success","schema":{"$ref":"#/definitions/TransactionRequestWithChargeJSON400"}},"400":{"description":"Error","schema":{"$ref":"#/definitions/ErrorAuthenticatedUserIsRequired"}}}}},"/obp/v5.1.0/banks/{BANK_ID}/accounts/{ACCOUNT_ID}/GRANT_VIEW_ID/transaction-request-types/{TRANSACTION_REQUEST_TYPE}/transaction-requests":{"post":{"tags":["Transaction-Request","Payment Initiation Service (PIS)","PSD2"],"summary":"Create Transaction Request (ACCOUNT)","security":[{"directLogin":[],"gatewayLogin":[]}],"description":"

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.

For an introduction to Transaction Requests, see: here

User Authentication is Required. The User must be logged in. The Application must also be authenticated.

URL Parameters:

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

BANK_ID: gh.29.uk

GRANT_VIEW_ID: GRANT_VIEW_ID

TRANSACTION_REQUEST_TYPE: SEPA

JSON request body fields:

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

amount: 10.12

bank_id: gh.29.uk

currency: EUR

description: Description of the object. 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

agent_number: 5987953

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: Description of the object. 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

status:

summary:

to:

transaction_ids:

transfer_type:

type:

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

value: 5987953

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

to_agent: to_agent

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:

","operationId":"OBPv4.0.0-createTransactionRequestAccount","parameters":[{"in":"body","name":"body","description":"TransactionRequestBodyJsonV200 object that needs to be added.","required":true,"schema":{"$ref":"#/definitions/TransactionRequestBodyJsonV200"}},{"in":"path","name":"TRANSACTION_REQUEST_TYPE","description":"The transaction request type","required":true,"type":"string"},{"in":"path","name":"ACCOUNT_ID","description":"The account id","required":true,"type":"string"},{"in":"path","name":"BANK_ID","description":"The bank id","required":true,"type":"string"}],"responses":{"201":{"description":"Success","schema":{"$ref":"#/definitions/TransactionRequestWithChargeJSON400"}},"400":{"description":"Error","schema":{"$ref":"#/definitions/ErrorAuthenticatedUserIsRequired"}}}}},"/obp/v5.1.0/banks/{BANK_ID}/accounts/{ACCOUNT_ID}/GRANT_VIEW_ID/transaction-request-types/{TRANSACTION_REQUEST_TYPE}/transaction-requests/{TRANSACTION_REQUEST_ID}/challenge":{"post":{"tags":["Transaction-Request","Payment Initiation Service (PIS)","PSD2"],"summary":"Answer Transaction Request Challenge","security":[{"directLogin":[],"gatewayLogin":[]}],"description":"

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 CBS 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.

User Authentication is Required. The User must be logged in. The Application must also be authenticated.

URL Parameters:

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

BANK_ID: gh.29.uk

GRANT_VIEW_ID: GRANT_VIEW_ID

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

TRANSACTION_REQUEST_TYPE: SEPA

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

agent_number: 5987953

allowed_attempts: 5

amount: 10.12

bank_code: CGHZ

bank_id: gh.29.uk

branch_number:

challenge:

challenge_type:

charge:

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

creditorAccount:

creditorName:

currency: EUR

date_of_birth: 2018-03-09

debtorAccount:

description: Description of the object. 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

status:

summary:

to:

transaction_ids:

transfer_type:

type:

value: 5987953

to_agent: to_agent

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:

","operationId":"OBPv4.0.0-answerTransactionRequestChallenge","parameters":[{"in":"body","name":"body","description":"ChallengeAnswerJson400 object that needs to be added.","required":true,"schema":{"$ref":"#/definitions/ChallengeAnswerJson400"}},{"in":"path","name":"TRANSACTION_REQUEST_ID","description":"The transaction request id","required":true,"type":"string"},{"in":"path","name":"TRANSACTION_REQUEST_TYPE","description":"The transaction request type","required":true,"type":"string"},{"in":"path","name":"ACCOUNT_ID","description":"The account id","required":true,"type":"string"},{"in":"path","name":"BANK_ID","description":"The bank id","required":true,"type":"string"}],"responses":{"201":{"description":"Success","schema":{"$ref":"#/definitions/TransactionRequestWithChargeJSON210"}},"400":{"description":"Error","schema":{"$ref":"#/definitions/ErrorAuthenticatedUserIsRequired"}}}}},"/obp/v5.1.0/banks/{BANK_ID}/accounts/{ACCOUNT_ID}/{VIEW_ID}/transaction-request-types":{"get":{"tags":["Transaction-Request","Payment Initiation Service (PIS)","PSD2"],"summary":"Get Transaction Request Types for Account","security":[{"directLogin":[],"gatewayLogin":[]}],"description":"

Returns the Transaction 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:

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.

User Authentication is Required. The User must be logged in. The Application must also be authenticated.

URL Parameters:

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

BANK_ID: gh.29.uk

VIEW_ID: owner

JSON response body fields:

amount: 10.12

charge:

currency: EUR

summary:

transaction_request_types:

value: 5987953

","operationId":"OBPv1.4.0-getTransactionRequestTypes","parameters":[{"in":"path","name":"VIEW_ID","description":"The view id","required":true,"type":"string"},{"in":"path","name":"ACCOUNT_ID","description":"The account id","required":true,"type":"string"},{"in":"path","name":"BANK_ID","description":"The bank id","required":true,"type":"string"}],"responses":{"200":{"description":"Success","schema":{"$ref":"#/definitions/TransactionRequestTypesJsonV140"}},"400":{"description":"Error","schema":{"$ref":"#/definitions/ErrorAuthenticatedUserIsRequired"}}}}},"/obp/v5.1.0/banks/{BANK_ID}/accounts/{ACCOUNT_ID}/{VIEW_ID}/transaction-request-types/COUNTERPARTY/transaction-requests/{TRANSACTION_REQUEST_ID}/challenge":{"post":{"tags":["Transaction-Request","Payment Initiation Service (PIS)","PSD2"],"summary":"Answer Transaction Request Challenge","security":[{"directLogin":[],"gatewayLogin":[]}],"description":"

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

This endpoint expects the following data as provided in the createTransactionRequest response body:

1)TRANSACTION_REQUEST_TYPE : as per the selected createTransactionRequest type, part of the request URL.

2)TRANSACTION_REQUEST_ID : the value of the id field of the createTransactionRequest response body.

3) id : the value of challenge.id in the createTransactionRequest response body.

4) answer : Defaults to 123, if running in sandbox mode. In production mode, the value will be sent via the configured SCA method.

User Authentication is Required. The User must be logged in. The Application must also be authenticated.

URL Parameters:

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

BANK_ID: gh.29.uk

COUNTERPARTY:

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

VIEW_ID: owner

JSON request body fields:

answer:

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

JSON response body fields:

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

allowed_attempts: 5

amount: 10.12

bank_id: gh.29.uk

challenge:

challenge_type:

charge:

currency: EUR

description: Description of the object. Maximum length is 2000. It can be any characters here.

details:

end_date:

from:

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

start_date: 2020-01-27

status:

summary:

to:

transaction_ids:

type:

value: 5987953

","operationId":"OBPv2.1.0-answerTransactionRequestChallengeCounterparty","parameters":[{"in":"body","name":"body","description":"ChallengeAnswerJSON object that needs to be added.","required":true,"schema":{"$ref":"#/definitions/ChallengeAnswerJSON"}},{"in":"path","name":"TRANSACTION_REQUEST_ID","description":"The transaction request id","required":true,"type":"string"},{"in":"path","name":"VIEW_ID","description":"The view id","required":true,"type":"string"},{"in":"path","name":"ACCOUNT_ID","description":"The account id","required":true,"type":"string"},{"in":"path","name":"BANK_ID","description":"The bank id","required":true,"type":"string"}],"responses":{"201":{"description":"Success","schema":{"$ref":"#/definitions/TransactionRequestWithChargeJson"}},"400":{"description":"Error","schema":{"$ref":"#/definitions/ErrorAuthenticatedUserIsRequired"}}}}},"/obp/v5.1.0/banks/{BANK_ID}/accounts/{ACCOUNT_ID}/{VIEW_ID}/transaction-request-types/FREE_FORM/transaction-requests/{TRANSACTION_REQUEST_ID}/challenge":{"post":{"tags":["Transaction-Request","Payment Initiation Service (PIS)","PSD2"],"summary":"Answer Transaction Request Challenge","security":[{"directLogin":[],"gatewayLogin":[]}],"description":"

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

This endpoint expects the following data as provided in the createTransactionRequest response body:

1)TRANSACTION_REQUEST_TYPE : as per the selected createTransactionRequest type, part of the request URL.

2)TRANSACTION_REQUEST_ID : the value of the id field of the createTransactionRequest response body.

3) id : the value of challenge.id in the createTransactionRequest response body.

4) answer : Defaults to 123, if running in sandbox mode. In production mode, the value will be sent via the configured SCA method.

User Authentication is Required. The User must be logged in. The Application must also be authenticated.

URL Parameters:

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

BANK_ID: gh.29.uk

FREE_FORM:

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

VIEW_ID: owner

JSON request body fields:

answer:

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

JSON response body fields:

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

allowed_attempts: 5

amount: 10.12

bank_id: gh.29.uk

challenge:

challenge_type:

charge:

currency: EUR

description: Description of the object. Maximum length is 2000. It can be any characters here.

details:

end_date:

from:

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

start_date: 2020-01-27

status:

summary:

to:

transaction_ids:

type:

value: 5987953

","operationId":"OBPv2.1.0-answerTransactionRequestChallengeFree_form","parameters":[{"in":"body","name":"body","description":"ChallengeAnswerJSON object that needs to be added.","required":true,"schema":{"$ref":"#/definitions/ChallengeAnswerJSON"}},{"in":"path","name":"TRANSACTION_REQUEST_ID","description":"The transaction request id","required":true,"type":"string"},{"in":"path","name":"VIEW_ID","description":"The view id","required":true,"type":"string"},{"in":"path","name":"ACCOUNT_ID","description":"The account id","required":true,"type":"string"},{"in":"path","name":"BANK_ID","description":"The bank id","required":true,"type":"string"}],"responses":{"201":{"description":"Success","schema":{"$ref":"#/definitions/TransactionRequestWithChargeJson"}},"400":{"description":"Error","schema":{"$ref":"#/definitions/ErrorAuthenticatedUserIsRequired"}}}}},"/obp/v5.1.0/banks/{BANK_ID}/accounts/{ACCOUNT_ID}/{VIEW_ID}/transaction-request-types/SANDBOX_TAN/transaction-requests/{TRANSACTION_REQUEST_ID}/challenge":{"post":{"tags":["Transaction-Request","Payment Initiation Service (PIS)","PSD2"],"summary":"Answer Transaction Request Challenge","security":[{"directLogin":[],"gatewayLogin":[]}],"description":"

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

This endpoint expects the following data as provided in the createTransactionRequest response body:

1)TRANSACTION_REQUEST_TYPE : as per the selected createTransactionRequest type, part of the request URL.

2)TRANSACTION_REQUEST_ID : the value of the id field of the createTransactionRequest response body.

3) id : the value of challenge.id in the createTransactionRequest response body.

4) answer : Defaults to 123, if running in sandbox mode. In production mode, the value will be sent via the configured SCA method.

User Authentication is Required. The User must be logged in. The Application must also be authenticated.

URL Parameters:

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

BANK_ID: gh.29.uk

SANDBOX_TAN:

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

VIEW_ID: owner

JSON request body fields:

answer:

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

JSON response body fields:

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

allowed_attempts: 5

amount: 10.12

bank_id: gh.29.uk

challenge:

challenge_type:

charge:

currency: EUR

description: Description of the object. Maximum length is 2000. It can be any characters here.

details:

end_date:

from:

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

start_date: 2020-01-27

status:

summary:

to:

transaction_ids:

type:

value: 5987953

","operationId":"OBPv2.1.0-answerTransactionRequestChallengeSandbox_tan","parameters":[{"in":"body","name":"body","description":"ChallengeAnswerJSON object that needs to be added.","required":true,"schema":{"$ref":"#/definitions/ChallengeAnswerJSON"}},{"in":"path","name":"TRANSACTION_REQUEST_ID","description":"The transaction request id","required":true,"type":"string"},{"in":"path","name":"VIEW_ID","description":"The view id","required":true,"type":"string"},{"in":"path","name":"ACCOUNT_ID","description":"The account id","required":true,"type":"string"},{"in":"path","name":"BANK_ID","description":"The bank id","required":true,"type":"string"}],"responses":{"201":{"description":"Success","schema":{"$ref":"#/definitions/TransactionRequestWithChargeJson"}},"400":{"description":"Error","schema":{"$ref":"#/definitions/ErrorAuthenticatedUserIsRequired"}}}}},"/obp/v5.1.0/banks/{BANK_ID}/accounts/{ACCOUNT_ID}/{VIEW_ID}/transaction-request-types/SEPA/transaction-requests/{TRANSACTION_REQUEST_ID}/challenge":{"post":{"tags":["Transaction-Request","Payment Initiation Service (PIS)","PSD2"],"summary":"Answer Transaction Request Challenge","security":[{"directLogin":[],"gatewayLogin":[]}],"description":"

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

This endpoint expects the following data as provided in the createTransactionRequest response body:

1)TRANSACTION_REQUEST_TYPE : as per the selected createTransactionRequest type, part of the request URL.

2)TRANSACTION_REQUEST_ID : the value of the id field of the createTransactionRequest response body.

3) id : the value of challenge.id in the createTransactionRequest response body.

4) answer : Defaults to 123, if running in sandbox mode. In production mode, the value will be sent via the configured SCA method.

User Authentication is Required. The User must be logged in. The Application must also be authenticated.

URL Parameters:

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

BANK_ID: gh.29.uk

SEPA:

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

VIEW_ID: owner

JSON request body fields:

answer:

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

JSON response body fields:

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

allowed_attempts: 5

amount: 10.12

bank_id: gh.29.uk

challenge:

challenge_type:

charge:

currency: EUR

description: Description of the object. Maximum length is 2000. It can be any characters here.

details:

end_date:

from:

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

start_date: 2020-01-27

status:

summary:

to:

transaction_ids:

type:

value: 5987953

","operationId":"OBPv2.1.0-answerTransactionRequestChallengeSepa","parameters":[{"in":"body","name":"body","description":"ChallengeAnswerJSON object that needs to be added.","required":true,"schema":{"$ref":"#/definitions/ChallengeAnswerJSON"}},{"in":"path","name":"TRANSACTION_REQUEST_ID","description":"The transaction request id","required":true,"type":"string"},{"in":"path","name":"VIEW_ID","description":"The view id","required":true,"type":"string"},{"in":"path","name":"ACCOUNT_ID","description":"The account id","required":true,"type":"string"},{"in":"path","name":"BANK_ID","description":"The bank id","required":true,"type":"string"}],"responses":{"201":{"description":"Success","schema":{"$ref":"#/definitions/TransactionRequestWithChargeJson"}},"400":{"description":"Error","schema":{"$ref":"#/definitions/ErrorAuthenticatedUserIsRequired"}}}}},"/obp/v5.1.0/banks/{BANK_ID}/accounts/{ACCOUNT_ID}/{VIEW_ID}/transaction-requests":{"get":{"tags":["Transaction-Request","Payment Initiation Service (PIS)"],"summary":"Get Transaction Requests","security":[{"directLogin":[],"gatewayLogin":[]}],"description":"

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:

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.

We support query transaction request by attribute
URL params example:/banks/BANK_ID/accounts/ACCOUNT_ID/VIEW_ID/transaction-requests?invoiceNumber=123&referenceNumber=456

User Authentication is Required. The User must be logged in. The Application must also be authenticated.

URL Parameters:

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

BANK_ID: gh.29.uk

VIEW_ID: owner

JSON response body fields:

account:

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

agent_number: 5987953

allowed_attempts: 5

amount: 10.12

bank_code: CGHZ

bank_id: gh.29.uk

branch_number:

challenge:

challenge_type:

charge:

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

creditorAccount:

creditorName:

currency: EUR

date_of_birth: 2018-03-09

debtorAccount:

description: Description of the object. 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

status:

summary:

to:

transaction_ids:

transaction_requests_with_charges:

transfer_type:

type:

value: 5987953

to_agent: to_agent

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:

","operationId":"OBPv5.1.0-getTransactionRequests","parameters":[{"in":"path","name":"VIEW_ID","description":"The view id","required":true,"type":"string"},{"in":"path","name":"ACCOUNT_ID","description":"The account id","required":true,"type":"string"},{"in":"path","name":"BANK_ID","description":"The bank id","required":true,"type":"string"}],"responses":{"200":{"description":"Success","schema":{"$ref":"#/definitions/TransactionRequestWithChargeJSONs210"}},"400":{"description":"Error","schema":{"$ref":"#/definitions/ErrorAuthenticatedUserIsRequired"}}}}},"/obp/v5.1.0/banks/{BANK_ID}/accounts/{ACCOUNT_ID}/{VIEW_ID}/transaction-requests/{TRANSACTION_REQUEST_ID}":{"get":{"tags":["Transaction-Request","Payment Initiation Service (PIS)","PSD2"],"summary":"Get Transaction Request","security":[{"directLogin":[],"gatewayLogin":[]}],"description":"

Returns transaction request for transaction specified by TRANSACTION_REQUEST_ID and 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:

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.

User Authentication is Required. The User must be logged in. The Application must also be authenticated.

URL Parameters:

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

BANK_ID: gh.29.uk

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

VIEW_ID: owner

JSON response body fields:

account:

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

agent_number: 5987953

allowed_attempts: 5

amount: 10.12

bank_code: CGHZ

bank_id: gh.29.uk

branch_number:

challenge:

challenge_type:

charge:

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

creditorAccount:

creditorName:

currency: EUR

date_of_birth: 2018-03-09

debtorAccount:

description: Description of the object. 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

status:

summary:

to:

transaction_ids:

transfer_type:

type:

value: 5987953

to_agent: to_agent

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:

","operationId":"OBPv4.0.0-getTransactionRequest","parameters":[{"in":"path","name":"TRANSACTION_REQUEST_ID","description":"The transaction request id","required":true,"type":"string"},{"in":"path","name":"VIEW_ID","description":"The view id","required":true,"type":"string"},{"in":"path","name":"ACCOUNT_ID","description":"The account id","required":true,"type":"string"},{"in":"path","name":"BANK_ID","description":"The bank id","required":true,"type":"string"}],"responses":{"200":{"description":"Success","schema":{"$ref":"#/definitions/TransactionRequestWithChargeJSON210"}},"400":{"description":"Error","schema":{"$ref":"#/definitions/ErrorAuthenticatedUserIsRequired"}}}}},"/obp/v5.1.0/banks/{BANK_ID}/accounts/{ACCOUNT_ID}/transaction-requests/{TRANSACTION_REQUEST_ID}/attribute":{"post":{"tags":["Transaction-Request","Transaction-Request-Attribute","Attribute"],"summary":"Create Transaction Request Attribute","security":[{"directLogin":[],"gatewayLogin":[]}],"description":"

Create Transaction Request Attribute

The type field must be one of \"STRING\", \"INTEGER\", \"DOUBLE\", \"DECIMAL\", \"BOOLEAN\" and \"DATE_WITH_DAY\". Use \"DECIMAL\" rather than \"DOUBLE\" for rates, prices and amounts, because it holds the value exactly; \"BOOLEAN\" values are \"true\" or \"false\".

User Authentication is Required. The User must be logged in. The Application must also be authenticated.

URL Parameters:

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

BANK_ID: gh.29.uk

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

JSON request body fields:

attribute_type: STRING

name: ACCOUNT_MANAGEMENT_FEE

value: 5987953

JSON response body fields:

name: ACCOUNT_MANAGEMENT_FEE

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

type:

value: 5987953

","operationId":"OBPv4.0.0-createTransactionRequestAttribute","parameters":[{"in":"body","name":"body","description":"TransactionRequestAttributeJsonV400 object that needs to be added.","required":true,"schema":{"$ref":"#/definitions/TransactionRequestAttributeJsonV400"}},{"in":"path","name":"TRANSACTION_REQUEST_ID","description":"The transaction request id","required":true,"type":"string"},{"in":"path","name":"ACCOUNT_ID","description":"The account id","required":true,"type":"string"},{"in":"path","name":"BANK_ID","description":"The bank id","required":true,"type":"string"}],"responses":{"201":{"description":"Success","schema":{"$ref":"#/definitions/TransactionRequestAttributeResponseJson"}},"400":{"description":"Error","schema":{"$ref":"#/definitions/ErrorAuthenticatedUserIsRequired"}}}}},"/obp/v5.1.0/banks/{BANK_ID}/accounts/{ACCOUNT_ID}/transaction-requests/{TRANSACTION_REQUEST_ID}/attributes":{"get":{"tags":["Transaction-Request","Transaction-Request-Attribute","Attribute"],"summary":"Get Transaction Request Attributes","security":[{"directLogin":[],"gatewayLogin":[]}],"description":"

Get Transaction Request Attributes

User Authentication is Required. The User must be logged in. The Application must also be authenticated.

URL Parameters:

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

BANK_ID: gh.29.uk

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

JSON response body fields:

name: ACCOUNT_MANAGEMENT_FEE

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

transaction_request_attributes: transaction_request_attributes

type:

value: 5987953

","operationId":"OBPv4.0.0-getTransactionRequestAttributes","parameters":[{"in":"path","name":"TRANSACTION_REQUEST_ID","description":"The transaction request id","required":true,"type":"string"},{"in":"path","name":"ACCOUNT_ID","description":"The account id","required":true,"type":"string"},{"in":"path","name":"BANK_ID","description":"The bank id","required":true,"type":"string"}],"responses":{"200":{"description":"Success","schema":{"$ref":"#/definitions/TransactionRequestAttributesResponseJson"}},"400":{"description":"Error","schema":{"$ref":"#/definitions/ErrorAuthenticatedUserIsRequired"}}}}},"/obp/v5.1.0/banks/{BANK_ID}/accounts/{ACCOUNT_ID}/transaction-requests/{TRANSACTION_REQUEST_ID}/attributes/ATTRIBUTE_ID":{"get":{"tags":["Transaction-Request","Transaction-Request-Attribute","Attribute"],"summary":"Get Transaction Request Attribute By Id","security":[{"directLogin":[],"gatewayLogin":[]}],"description":"

Get Transaction Request Attribute By Id

User Authentication is Required. The User must be logged in. The Application must also be authenticated.

URL Parameters:

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

ATTRIBUTE_ID:

BANK_ID: gh.29.uk

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

JSON response body fields:

name: ACCOUNT_MANAGEMENT_FEE

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

type:

value: 5987953

","operationId":"OBPv4.0.0-getTransactionRequestAttributeById","parameters":[{"in":"path","name":"TRANSACTION_REQUEST_ID","description":"The transaction request id","required":true,"type":"string"},{"in":"path","name":"ACCOUNT_ID","description":"The account id","required":true,"type":"string"},{"in":"path","name":"BANK_ID","description":"The bank id","required":true,"type":"string"}],"responses":{"200":{"description":"Success","schema":{"$ref":"#/definitions/TransactionRequestAttributeResponseJson"}},"400":{"description":"Error","schema":{"$ref":"#/definitions/ErrorAuthenticatedUserIsRequired"}}}},"put":{"tags":["Transaction-Request","Transaction-Request-Attribute","Attribute"],"summary":"Update Transaction Request Attribute","security":[{"directLogin":[],"gatewayLogin":[]}],"description":"

Update Transaction Request Attribute

User Authentication is Required. The User must be logged in. The Application must also be authenticated.

URL Parameters:

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

ATTRIBUTE_ID:

BANK_ID: gh.29.uk

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

JSON response body fields:

name: ACCOUNT_MANAGEMENT_FEE

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

type:

value: 5987953

","operationId":"OBPv4.0.0-updateTransactionRequestAttribute","parameters":[{"in":"body","name":"body","description":"TransactionRequestAttributeJsonV400 object that needs to be added.","required":true,"schema":{"$ref":"#/definitions/TransactionRequestAttributeJsonV400"}},{"in":"path","name":"TRANSACTION_REQUEST_ID","description":"The transaction request id","required":true,"type":"string"},{"in":"path","name":"ACCOUNT_ID","description":"The account id","required":true,"type":"string"},{"in":"path","name":"BANK_ID","description":"The bank id","required":true,"type":"string"}],"responses":{"200":{"description":"Success","schema":{"$ref":"#/definitions/TransactionRequestAttributeResponseJson"}},"400":{"description":"Error","schema":{"$ref":"#/definitions/ErrorAuthenticatedUserIsRequired"}}}}},"/obp/v5.1.0/banks/{BANK_ID}/attribute-definitions/ATTRIBUTE_DEFINITION_ID/transaction-request":{"delete":{"tags":["Transaction-Request","Transaction-Request-Attribute","Attribute"],"summary":"Delete Transaction Request Attribute Definition","security":[{"directLogin":[],"gatewayLogin":[]}],"description":"

Delete Transaction Request Attribute Definition by ATTRIBUTE_DEFINITION_ID

User Authentication is Required. The User must be logged in. The Application must also be authenticated.

URL Parameters:

ATTRIBUTE_DEFINITION_ID:

BANK_ID: gh.29.uk

JSON response body fields:

","operationId":"OBPv4.0.0-deleteTransactionRequestAttributeDefinition","parameters":[{"in":"path","name":"BANK_ID","description":"The bank id","required":true,"type":"string"}],"responses":{"204":{"description":"Success","schema":{"$ref":"#/definitions/Full"}},"400":{"description":"Error","schema":{"$ref":"#/definitions/ErrorAuthenticatedUserIsRequired"}}}}},"/obp/v5.1.0/banks/{BANK_ID}/attribute-definitions/transaction-request":{"get":{"tags":["Transaction-Request","Transaction-Request-Attribute","Attribute"],"summary":"Get Transaction Request Attribute Definition","security":[{"directLogin":[],"gatewayLogin":[]}],"description":"

Get Transaction Request Attribute Definition

User Authentication is Required. The User must be logged in. The Application must also be authenticated.

URL Parameters:

BANK_ID: gh.29.uk

JSON response body fields:

alias:

attribute_definition_id:

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

bank_id: gh.29.uk

can_be_seen_on_views: false

category:

description: Description of the object. Maximum length is 2000. It can be any characters here.

is_active: false

name: ACCOUNT_MANAGEMENT_FEE

type:

","operationId":"OBPv4.0.0-getTransactionRequestAttributeDefinition","parameters":[{"in":"path","name":"BANK_ID","description":"The bank id","required":true,"type":"string"}],"responses":{"200":{"description":"Success","schema":{"$ref":"#/definitions/AttributeDefinitionsResponseJsonV400"}},"400":{"description":"Error","schema":{"$ref":"#/definitions/ErrorAuthenticatedUserIsRequired"}}}},"put":{"tags":["Transaction-Request","Transaction-Request-Attribute","Attribute"],"summary":"Create or Update Transaction Request Attribute Definition","security":[{"directLogin":[],"gatewayLogin":[]}],"description":"

Create or Update Transaction Request Attribute Definition

The category field must be TransactionRequest

The type field must be one of: DOUBLE, STRING, INTEGER and DATE_WITH_DAY

User Authentication is Required. The User must be logged in. The Application must also be authenticated.

URL Parameters:

BANK_ID: gh.29.uk

JSON response body fields:

alias:

attribute_definition_id:

bank_id: gh.29.uk

can_be_seen_on_views: false

category:

description: Description of the object. Maximum length is 2000. It can be any characters here.

is_active: false

name: ACCOUNT_MANAGEMENT_FEE

type:

","operationId":"OBPv4.0.0-createOrUpdateTransactionRequestAttributeDefinition","parameters":[{"in":"body","name":"body","description":"AttributeDefinitionJsonV400 object that needs to be added.","required":true,"schema":{"$ref":"#/definitions/AttributeDefinitionJsonV400"}},{"in":"path","name":"BANK_ID","description":"The bank id","required":true,"type":"string"}],"responses":{"200":{"description":"Success","schema":{"$ref":"#/definitions/AttributeDefinitionResponseJsonV400"}},"400":{"description":"Error","schema":{"$ref":"#/definitions/ErrorAuthenticatedUserIsRequired"}}}}},"/obp/v5.1.0/banks/{BANK_ID}/management/historical/transactions":{"post":{"tags":["Transaction-Request"],"summary":"Create Historical Transactions ","security":[{"directLogin":[],"gatewayLogin":[]}],"description":"

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.

User Authentication is Required. The User must be logged in. The Application must also be authenticated.

URL Parameters:

BANK_ID: gh.29.uk

JSON request body fields:

amount: 10.12

charge_policy: SHARED

completed: 2020-01-27

currency: EUR

description: Description of the object. 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: Description of the object. 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

","operationId":"OBPv4.0.0-createHistoricalTransactionAtBank","parameters":[{"in":"body","name":"body","description":"PostHistoricalTransactionAtBankJson object that needs to be added.","required":true,"schema":{"$ref":"#/definitions/PostHistoricalTransactionAtBankJson"}},{"in":"path","name":"BANK_ID","description":"The bank id","required":true,"type":"string"}],"responses":{"201":{"description":"Success","schema":{"$ref":"#/definitions/PostHistoricalTransactionResponseJson"}},"400":{"description":"Error","schema":{"$ref":"#/definitions/ErrorInvalidJsonFormat"}}}}},"/obp/v5.1.0/banks/{BANK_ID}/transaction-request-types":{"get":{"tags":["Transaction-Request","Bank"],"summary":"Get Transaction Request Types at Bank","security":[{"directLogin":[],"gatewayLogin":[]}],"description":"

Get the list of the Transaction Request Types supported by the bank.

User Authentication is Optional. The User need not be logged in.

URL Parameters:

BANK_ID: gh.29.uk

JSON response body fields:

transaction_request_type: SEPA

transaction_request_types:

","operationId":"OBPv2.1.0-getTransactionRequestTypesSupportedByBank","parameters":[{"in":"path","name":"BANK_ID","description":"The bank id","required":true,"type":"string"}],"responses":{"200":{"description":"Success","schema":{"$ref":"#/definitions/TransactionRequestTypesJSON"}},"400":{"description":"Error","schema":{"$ref":"#/definitions/ErrorUnknownError"}}}}},"/obp/v5.1.0/consumer/vrp-consent-requests":{"post":{"tags":["Consent","VRP","Transaction-Request"],"summary":"Create Consent Request VRP","security":[{"directLogin":[],"gatewayLogin":[]}],"description":"

This endpoint is used to begin the process of creating a consent that may be used for Variable Recurring Payments (VRPs).

VRPs are useful in situations when a beneficiary needs to be paid different amounts on a regular basis.

Once granted, the consent allows its holder to initiate multiple Transaction Requests to the Counterparty defined in this endpoint as long as the
Counterparty Limits linked to this particular consent are respected.

Client, Consumer or Application Authentication is mandatory for this endpoint.

i.e. the caller of this endpoint is the API Client, Consumer or Application rather than a specific User.

At the end of the process the following objects are created in OBP or connected backend systems:
- An automatically generated View which controls access.
- A Counterparty that is the Beneficiary of the Variable Recurring Payments. The Counterparty specifies the Bank Account number or other routing address.
- Limits for the Counterparty which constrain the amount of money that can be sent to it in various periods (yearly, monthly, weekly).

The Account holder may modify the Counterparty or Limits e.g. to increase or decrease the maximum possible payment amounts or the frequencey of the payments.

In the case of a public client we use the client_id and private key to obtain an access token, otherwise we use the client_id and client_secret.
The obtained access token is used in the HTTP Authorization header of the request as follows:

Example:
Authorization: Bearer eXtneO-THbQtn3zvK_kQtXXfvOZyZFdBCItlPDbR2Bk.dOWqtXCtFX-tqGTVR0YrIjvAolPIVg7GZ-jz83y6nA0

After successfully creating the VRP consent request, you need to call the Create Consent By CONSENT_REQUEST_ID endpoint to finalize the consent using the CONSENT_REQUEST_ID returned by this endpoint.

Application Access is Required. The Application must be authenticated.

User Authentication is Optional. The User need not be logged in.

JSON request body fields:

account_routing:

address:

bank_routing:

branch_routing:

counterparty_name: John Smith Ltd.

currency: EUR

from_account: from_account

limit: 100

max_monthly_amount: 10000.11

max_number_of_monthly_transactions: 10

max_number_of_transactions: 100

max_number_of_yearly_transactions: 100

max_single_amount: 1000.11

max_total_amount: 10000.12

max_yearly_amount: 12000.11

scheme: OBP

to_account: to_account

email: felixsmith@example.com

phone_number:

time_to_live:

valid_from: 2020-01-27

JSON response body fields:

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

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

payload: payload

","operationId":"OBPv5.1.0-createVRPConsentRequest","parameters":[{"in":"body","name":"body","description":"PostVRPConsentRequestJsonV510 object that needs to be added.","required":true,"schema":{"$ref":"#/definitions/PostVRPConsentRequestJsonV510"}}],"responses":{"201":{"description":"Success","schema":{"$ref":"#/definitions/ConsentRequestResponseJson"}},"400":{"description":"Error","schema":{"$ref":"#/definitions/ErrorInvalidJsonFormat"}}}}},"/obp/v5.1.0/management/historical/transactions":{"post":{"tags":["Transaction-Request"],"summary":"Save Historical Transactions","security":[{"directLogin":[],"gatewayLogin":[]}],"description":"

Import the historical transactions.

The fields bank_id, account_id, counterparty_id in the json body are all optional ones.
It support transfer money from account to account, account to counterparty and counterparty to counterparty
Both bank_id + account_id and counterparty_id can identify the account, so OBP only need one of them to make the payment.
So:
When you need the account to account, just omit counterparty_id field.eg:
{
\"from\": {
\"bank_id\": \"gh.29.uk\",
\"account_id\": \"1ca8a7e4-6d02-48e3-a029-0b2bf89de9f0\",
},
\"to\": {
\"bank_id\": \"gh.29.uk\",
\"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\"
}

When you need the counterparty to counterparty, need to omit bank_id and account_id field.eg:
{
\"from\": {
\"counterparty_id\": \"f6392b7d-4218-45ea-b9a7-eaa71c0202f9\"
},
\"to\": {
\"counterparty_id\": \"26392b7d-4218-45ea-b9a7-eaa71c0202f9\"
},
\"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\"
}

or, you can counterparty to account
{
\"from\": {
\"counterparty_id\": \"f6392b7d-4218-45ea-b9a7-eaa71c0202f9\"
},
\"to\": {
\"bank_id\": \"gh.29.uk\",
\"account_id\": \"8ca8a7e4-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.

User Authentication is Required. The User must be logged in. The Application must also be authenticated.

JSON request body fields:

amount: 10.12

charge_policy: SHARED

completed: 2020-01-27

currency: EUR

description: Description of the object. Maximum length is 2000. It can be any characters here.

from:

posted: 2020-01-27

to:

type:

value: 5987953

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

bank_id: gh.29.uk

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

JSON response body fields:

amount: 10.12

charge_policy: SHARED

completed: 2020-01-27

currency: EUR

description: Description of the object. 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

","operationId":"OBPv3.1.0-saveHistoricalTransaction","parameters":[{"in":"body","name":"body","description":"PostHistoricalTransactionJson object that needs to be added.","required":true,"schema":{"$ref":"#/definitions/PostHistoricalTransactionJson"}}],"responses":{"201":{"description":"Success","schema":{"$ref":"#/definitions/PostHistoricalTransactionResponseJson"}},"400":{"description":"Error","schema":{"$ref":"#/definitions/ErrorInvalidJsonFormat"}}}}},"/obp/v5.1.0/management/transaction-requests/{TRANSACTION_REQUEST_ID}":{"get":{"tags":["Transaction-Request","Payment Initiation Service (PIS)","PSD2"],"summary":"Get Transaction Request by ID","security":[{"directLogin":[],"gatewayLogin":[]}],"description":"

Returns transaction request for transaction specified by TRANSACTION_REQUEST_ID.

User Authentication is Required. The User must be logged in. The Application must also be authenticated.

URL Parameters:

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

JSON response body fields:

account:

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

agent_number: 5987953

allowed_attempts: 5

amount: 10.12

bank_code: CGHZ

bank_id: gh.29.uk

branch_number:

challenge:

challenge_type:

charge:

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

creditorAccount:

creditorName:

currency: EUR

date_of_birth: 2018-03-09

debtorAccount:

description: Description of the object. 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

status:

summary:

to:

transaction_ids:

transfer_type:

type:

value: 5987953

to_agent: to_agent

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:

","operationId":"OBPv5.1.0-getTransactionRequestById","parameters":[{"in":"path","name":"TRANSACTION_REQUEST_ID","description":"The transaction request id","required":true,"type":"string"}],"responses":{"200":{"description":"Success","schema":{"$ref":"#/definitions/TransactionRequestWithChargeJSON210"}},"400":{"description":"Error","schema":{"$ref":"#/definitions/ErrorAuthenticatedUserIsRequired"}}}},"put":{"tags":["Transaction-Request"],"summary":"Update Transaction Request Status","security":[{"directLogin":[],"gatewayLogin":[]}],"description":"

Update Transaction Request Status

User Authentication is Required. The User must be logged in. The Application must also be authenticated.

URL Parameters:

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

JSON response body fields:

status:

","operationId":"OBPv5.1.0-updateTransactionRequestStatus","parameters":[{"in":"body","name":"body","description":"PostTransactionRequestStatusJsonV510 object that needs to be added.","required":true,"schema":{"$ref":"#/definitions/PostTransactionRequestStatusJsonV510"}},{"in":"path","name":"TRANSACTION_REQUEST_ID","description":"The transaction request id","required":true,"type":"string"}],"responses":{"200":{"description":"Success","schema":{"$ref":"#/definitions/PostTransactionRequestStatusJsonV510"}},"400":{"description":"Error","schema":{"$ref":"#/definitions/ErrorAuthenticatedUserIsRequired"}}}}},"/obp/v5.1.0/transaction-request-types/CARD/transaction-requests":{"post":{"tags":["Transaction-Request","Payment Initiation Service (PIS)","PSD2"],"summary":"Create Transaction Request (CARD)","security":[{"directLogin":[],"gatewayLogin":[]}],"description":"

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

Money goes into the Counterparty in the request body.

For an introduction to Transaction Requests, see: here

User Authentication is Required. The User must be logged in. The Application must also be authenticated.

URL Parameters:

CARD: CARD

JSON request body fields:

amount: 10.12

brand: Visa

card: card

card_number: 364435172576215

card_type: Credit

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

currency: EUR

cvv: 123

description: Description of the object. Maximum length is 2000. It can be any characters here.

expiry_month: 01

expiry_year: 2023

name_on_card: SusanSmith

to:

value: 5987953

JSON response body fields:

account:

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

agent_number: 5987953

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: Description of the object. 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

status:

summary:

to:

transaction_ids:

transfer_type:

type:

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

value: 5987953

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

to_agent: to_agent

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:

","operationId":"OBPv4.0.0-createTransactionRequestCard","parameters":[{"in":"body","name":"body","description":"TransactionRequestBodyCardJsonV400 object that needs to be added.","required":true,"schema":{"$ref":"#/definitions/TransactionRequestBodyCardJsonV400"}}],"responses":{"201":{"description":"Success","schema":{"$ref":"#/definitions/TransactionRequestWithChargeJSON400"}},"400":{"description":"Error","schema":{"$ref":"#/definitions/ErrorAuthenticatedUserIsRequired"}}}}}},"definitions":{"ErrorInvalidJsonFormat":{"properties":{"message":{"type":"string","example":"OBP-10001: Incorrect json format."}}},"ErrorAuthenticatedUserIsRequired":{"properties":{"message":{"type":"string","example":"OBP-20001: User not logged in. Authentication is required!"}}},"ErrorUnknownError":{"properties":{"message":{"type":"string","example":"OBP-50000: Unknown Error."}}},"ChallengeAnswerJSON":{"required":["id","answer"],"properties":{"id":{"type":"string","example":"This is challenge.id, you can get it from `Create Transaction Request.` response, only is useful if status ==`INITIATED` there."},"answer":{"type":"string","example":"123"}}},"TransactionRequestBodyJsonV200":{"required":["to","value","description"],"properties":{"to":{"$ref":"#/definitions/TransactionRequestAccountJsonV140"},"value":{"$ref":"#/definitions/AmountOfMoneyJsonV121"},"description":{"type":"string","example":"this is for work"}}},"PostTransactionRequestStatusJsonV510":{"required":["status"],"properties":{"status":{"type":"string","example":"COMPLETED"}}},"PostHistoricalTransactionAtBankJson":{"required":["completed","charge_policy","from_account_id","type","value","posted","description","to_account_id"],"properties":{"completed":{"type":"string","example":"1100-01-01T01:01:01Z"},"charge_policy":{"type":"string","example":"SHARED"},"from_account_id":{"type":"string","example":""},"type":{"type":"string","example":"SANDBOX_TAN"},"value":{"$ref":"#/definitions/AmountOfMoneyJsonV121"},"posted":{"type":"string","example":"1100-01-01T01:01:01Z"},"description":{"type":"string","example":"this is for work"},"to_account_id":{"type":"string","example":""}}},"TransactionRequestBodyCounterpartyJSON":{"required":["description","to","charge_policy","value"],"properties":{"attributes":{"type":"array","items":{"$ref":"#/definitions/TransactionRequestAttributeJsonV400"}},"to":{"$ref":"#/definitions/CounterpartyIdJson"},"charge_policy":{"type":"string","example":"SHARED"},"value":{"$ref":"#/definitions/AmountOfMoneyJsonV121"},"description":{"type":"string","example":"A description for the transaction to the counterparty"},"future_date":{"type":"string","example":"20200127"}}},"TransactionRequestAttributeJsonV400":{"required":["name","attribute_type","value"],"properties":{"name":{"type":"string","example":"HOUSE_RENT"},"attribute_type":{"type":"string","example":"STRING"},"value":{"type":"string","example":"123456789"}}},"TransactionRequestBodyCardJsonV400":{"required":["card","to","value","description"],"properties":{"card":{"$ref":"#/definitions/CardJsonV400"},"to":{"$ref":"#/definitions/CounterpartyIdJson"},"value":{"$ref":"#/definitions/AmountOfMoneyJsonV121"},"description":{"type":"string","example":"A card payment description. "}}},"TransactionRequestBodyAgentJsonV400":{"required":["description","to","charge_policy","value"],"properties":{"to":{"$ref":"#/definitions/AgentCashWithdrawalJson"},"charge_policy":{"type":"string","example":"SHARED"},"value":{"$ref":"#/definitions/AmountOfMoneyJsonV121"},"description":{"type":"string","example":"Description of the object. Maximum length is 2000. It can be any characters here."},"future_date":{"type":"string","example":"20200127"}}},"TransactionRequestBodyFreeFormJSON":{"required":["value","description"],"properties":{"value":{"$ref":"#/definitions/AmountOfMoneyJsonV121"},"description":{"type":"string","example":"This is a FREE_FORM Transaction Request"}}},"ChallengeAnswerJson400":{"required":["id","answer"],"properties":{"id":{"type":"string","example":"This is challenge.id, you can get it from `Create Transaction Request.` response, only is useful if status ==`INITIATED` there."},"answer":{"type":"string","example":"123"},"reason_code":{"type":"string","example":"[Optional] Reason code for REJECT answer (e.g. 'CUST')"},"additional_information":{"type":"string","example":"[Optional] Additional description for REJECT answer"}}},"TransactionRequestBodySimpleJsonV400":{"required":["description","to","charge_policy","value"],"properties":{"to":{"$ref":"#/definitions/PostSimpleCounterpartyJson400"},"charge_policy":{"type":"string","example":"SHARED"},"value":{"$ref":"#/definitions/AmountOfMoneyJsonV121"},"description":{"type":"string","example":"Description of the object. Maximum length is 2000. It can be any characters here."},"future_date":{"type":"string","example":"20200127"}}},"PostVRPConsentRequestJsonV510":{"required":["from_account","to_account"],"properties":{"phone_number":{"type":"string","example":"+44 07972 444 876"},"time_to_live":{"type":"integer","format":"int64","example":"3600"},"email":{"type":"string","example":"felixsmith@example.com"},"from_account":{"$ref":"#/definitions/ConsentRequestFromAccountJson"},"valid_from":{"type":"string","format":"date","example":"2026-10-15T02:00:41Z"},"to_account":{"$ref":"#/definitions/ConsentRequestToAccountJson"}}},"TransactionRequestBodyRefundJsonV400":{"required":["description","refund","value"],"properties":{"description":{"type":"string","example":"A refund description. "},"refund":{"$ref":"#/definitions/RefundJson"},"to":{"$ref":"#/definitions/TransactionRequestRefundTo"},"from":{"$ref":"#/definitions/TransactionRequestRefundFrom"},"value":{"$ref":"#/definitions/AmountOfMoneyJsonV121"}}},"TransactionRequestBodySEPAJsonV400":{"required":["description","to","charge_policy","value"],"properties":{"to":{"$ref":"#/definitions/IbanJson"},"charge_policy":{"type":"string","example":"SHARED"},"description":{"type":"string","example":"This is a SEPA Transaction Request"},"future_date":{"type":"string","example":"20200127"},"value":{"$ref":"#/definitions/AmountOfMoneyJsonV121"},"reasons":{"type":"array","items":{"$ref":"#/definitions/TransactionRequestReasonJsonV400"}}}},"AttributeDefinitionJsonV400":{"required":["description","alias","type","name","is_active","can_be_seen_on_views","category"],"properties":{"description":{"type":"string","example":"description"},"alias":{"type":"string","example":"STRING"},"type":{"type":"string","example":"STRING"},"name":{"type":"string","example":"SPECIAL_TAX_NUMBER"},"is_active":{"type":"boolean","example":"true"},"can_be_seen_on_views":{"type":"array","items":{"type":"string"}},"category":{"type":"string","example":"TransactionRequest"}}},"PostHistoricalTransactionJson":{"required":["description","to","completed","type","value","posted","charge_policy","from"],"properties":{"description":{"type":"string","example":"this is for work"},"to":{"$ref":"#/definitions/HistoricalTransactionAccountJsonV310"},"completed":{"type":"string","example":"1100-01-01T01:01:01Z"},"type":{"type":"string","example":"SANDBOX_TAN"},"value":{"$ref":"#/definitions/AmountOfMoneyJsonV121"},"posted":{"type":"string","example":"1100-01-01T01:01:01Z"},"charge_policy":{"type":"string","example":"SHARED"},"from":{"$ref":"#/definitions/HistoricalTransactionAccountJsonV310"}}},"TransactionRequestWithChargeJson":{"required":["challenge","start_date","id","from","type","transaction_ids","end_date","status","details","charge"],"properties":{"challenge":{"$ref":"#/definitions/ChallengeJsonV140"},"start_date":{"type":"string","format":"date","example":"1100-01-01T00:00:00Z"},"id":{"type":"string","example":"82f92531-9c63-4246-abfc-96c20ec46188"},"from":{"$ref":"#/definitions/TransactionRequestAccountJsonV140"},"type":{"type":"string","example":"SANDBOX_TAN"},"transaction_ids":{"type":"string","example":"666666-9c63-4246-abfc-96c20ec46188"},"end_date":{"type":"string","format":"date","example":"1100-01-01T00:00:00Z"},"status":{"type":"string","example":"COMPLETED"},"details":{"$ref":"#/definitions/TransactionRequestBody"},"charge":{"$ref":"#/definitions/TransactionRequestChargeJsonV200"}}},"TransactionRequestWithChargeJSON210":{"required":["challenge","start_date","id","from","type","transaction_ids","end_date","status","details","charge"],"properties":{"challenge":{"$ref":"#/definitions/ChallengeJsonV140"},"start_date":{"type":"string","format":"date","example":"1100-01-01T00:00:00Z"},"id":{"type":"string","example":"4050046c-63b3-4868-8a22-14b4181d33a6"},"from":{"$ref":"#/definitions/TransactionRequestAccountJsonV140"},"type":{"type":"string","example":"SANDBOX_TAN"},"transaction_ids":{"type":"array","items":{"type":"string"}},"end_date":{"type":"string","format":"date","example":"1100-01-01T00:00:00Z"},"status":{"type":"string","example":"COMPLETED"},"details":{"$ref":"#/definitions/TransactionRequestBodyAllTypes"},"charge":{"$ref":"#/definitions/TransactionRequestChargeJsonV200"}}},"PostHistoricalTransactionResponseJson":{"required":["description","to","transaction_id","transaction_request_type","completed","value","posted","charge_policy","from"],"properties":{"description":{"type":"string","example":"this is for work"},"to":{"$ref":"#/definitions/HistoricalTransactionAccountJsonV310"},"transaction_id":{"type":"string","example":"2fg8a7e4-6d02-40e3-a129-0b2bf89de8ub"},"transaction_request_type":{"type":"string","example":"SANDBOX_TAN"},"completed":{"type":"string","format":"date","example":"1100-01-01T01:01:01Z"},"value":{"$ref":"#/definitions/AmountOfMoneyJsonV121"},"posted":{"type":"string","format":"date","example":"1100-01-01T01:01:01Z"},"charge_policy":{"type":"string","example":"SHARED"},"from":{"$ref":"#/definitions/HistoricalTransactionAccountJsonV310"}}},"TransactionRequestWithChargeJSON400":{"required":["start_date","id","from","type","end_date","status","details","charge","transaction_ids","challenges"],"properties":{"start_date":{"type":"string","format":"date","example":"1100-01-01T00:00:00Z"},"attributes":{"type":"array","items":{"$ref":"#/definitions/BankAttributeBankResponseJsonV400"}},"id":{"type":"string","example":"4050046c-63b3-4868-8a22-14b4181d33a6"},"from":{"$ref":"#/definitions/TransactionRequestAccountJsonV140"},"type":{"type":"string","example":"SANDBOX_TAN"},"end_date":{"type":"string","format":"date","example":"1100-01-01T00:00:00Z"},"status":{"type":"string","example":"COMPLETED"},"details":{"$ref":"#/definitions/TransactionRequestBodyAllTypes"},"charge":{"$ref":"#/definitions/TransactionRequestChargeJsonV200"},"transaction_ids":{"type":"array","items":{"type":"string"}},"challenges":{"type":"array","items":{"$ref":"#/definitions/ChallengeJsonV400"}}}},"TransactionRequestAttributeResponseJson":{"required":["transaction_request_attribute_id","name","type","value"],"properties":{"transaction_request_attribute_id":{"type":"string","example":"7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh"},"name":{"type":"string","example":"HOUSE_RENT"},"type":{"type":"string","example":"STRING"},"value":{"type":"string","example":"123456789"}}},"AttributeDefinitionsResponseJsonV400":{"required":["attributes"],"properties":{"attributes":{"type":"array","items":{"$ref":"#/definitions/AttributeDefinitionResponseJsonV400"}}}},"TransactionRequestWithChargeJSONs210":{"required":["transaction_requests_with_charges"],"properties":{"transaction_requests_with_charges":{"type":"array","items":{"$ref":"#/definitions/TransactionRequestWithChargeJSON210"}}}},"TransactionRequestAttributesResponseJson":{"required":["transaction_request_attributes"],"properties":{"transaction_request_attributes":{"type":"array","items":{"$ref":"#/definitions/TransactionRequestAttributeResponseJson"}}}},"TransactionRequestTypesJsonV140":{"required":["transaction_request_types"],"properties":{"transaction_request_types":{"type":"array","items":{"$ref":"#/definitions/TransactionRequestTypeJsonV140"}}}},"Full":{"required":["value"],"properties":{"value":{"type":"boolean","example":"true"}}},"ConsentRequestResponseJson":{"required":["consent_request_id","payload","consumer_id"],"properties":{"consent_request_id":{"type":"string","example":"8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0"},"payload":{"type":"object","properties":{"from_account":{"type":"object","properties":{"bank_routing":{"type":"object","properties":{"scheme":{"type":"string","example":"OBP"},"address":{"type":"string","example":"gh.29.uk"}},"required":["scheme","address"]},"account_routing":{"type":"object","properties":{"scheme":{"type":"string","example":"OBP"},"address":{"type":"string","example":"8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0"}},"required":["scheme","address"]},"branch_routing":{"type":"object","properties":{"scheme":{"type":"string","example":"OBP"},"address":{"type":"string","example":"DERBY6"}},"required":["scheme","address"]}},"required":["bank_routing","account_routing","branch_routing"]},"to_account":{"type":"object","properties":{"bank_routing":{"type":"object","properties":{"scheme":{"type":"string","example":"OBP"},"address":{"type":"string","example":"gh.29.uk"}},"required":["scheme","address"]},"account_routing":{"type":"object","properties":{"scheme":{"type":"string","example":"OBP"},"address":{"type":"string","example":"8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0"}},"required":["scheme","address"]},"branch_routing":{"type":"object","properties":{"scheme":{"type":"string","example":"OBP"},"address":{"type":"string","example":"DERBY6"}},"required":["scheme","address"]},"limit":{"type":"object","properties":{"currency":{"type":"string","example":"EUR"},"max_single_amount":{"type":"integer","format":"int32","example":"1000"},"max_monthly_amount":{"type":"integer","format":"int32","example":"10000"},"max_number_of_monthly_transactions":{"type":"integer","format":"int32","example":"10"},"max_yearly_amount":{"type":"integer","format":"int32","example":"12000"},"max_number_of_yearly_transactions":{"type":"integer","format":"int32","example":"100"}},"required":["currency","max_single_amount","max_monthly_amount","max_number_of_monthly_transactions","max_yearly_amount","max_number_of_yearly_transactions"]}},"required":["bank_routing","account_routing","branch_routing","limit"]},"valid_from":{"type":"string","example":"2024-07-10T09:22:06Z"},"time_to_live":{"type":"integer","format":"int32","example":"3600"}},"required":["from_account","to_account","valid_from","time_to_live"]},"consumer_id":{"type":"string","example":"7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh"}}},"TransactionRequestTypesJSON":{"required":["transaction_request_types"],"properties":{"transaction_request_types":{"type":"array","items":{"$ref":"#/definitions/TransactionRequestTypeJSONV210"}}}},"AttributeDefinitionResponseJsonV400":{"required":["description","attribute_definition_id","alias","bank_id","type","name","is_active","can_be_seen_on_views","category"],"properties":{"description":{"type":"string","example":"description"},"attribute_definition_id":{"type":"string","example":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1"},"alias":{"type":"string","example":"STRING"},"bank_id":{"type":"string","example":"gh.29.uk"},"type":{"type":"string","example":"STRING"},"name":{"type":"string","example":"SPECIAL_TAX_NUMBER"},"is_active":{"type":"boolean","example":"true"},"can_be_seen_on_views":{"type":"array","items":{"type":"string"}},"category":{"type":"string","example":"TransactionRequest"}}},"TransactionRequestAccountJsonV140":{"required":["bank_id","account_id"],"properties":{"bank_id":{"type":"string","example":"gh.29.uk"},"account_id":{"type":"string","example":"8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0"}}},"AmountOfMoneyJsonV121":{"required":["currency","amount"],"properties":{"currency":{"type":"string","example":"EUR"},"amount":{"type":"string","example":"0"}}},"CounterpartyIdJson":{"required":["counterparty_id"],"properties":{"counterparty_id":{"type":"string","example":"9fg8a7e4-6d02-40e3-a129-0b2bf89de8uh"}}},"CardJsonV400":{"required":["expiry_year","cvv","expiry_month","name_on_card","card_type","brand","card_number"],"properties":{"expiry_year":{"type":"string","example":"2023"},"cvv":{"type":"string","example":"123"},"expiry_month":{"type":"string","example":"01"},"name_on_card":{"type":"string","example":"SusanSmith"},"card_type":{"type":"string","example":"Credit"},"brand":{"type":"string","example":"Visa"},"card_number":{"type":"string","example":"364435172576215"}}},"AgentCashWithdrawalJson":{"required":["bank_id","agent_number"],"properties":{"bank_id":{"type":"string","example":"gh.29.uk"},"agent_number":{"type":"string","example":"5987953"}}},"PostSimpleCounterpartyJson400":{"required":["name","other_account_secondary_routing_address","description","other_branch_routing_address","other_bank_routing_scheme","other_branch_routing_scheme","other_bank_routing_address","other_account_secondary_routing_scheme","other_account_routing_address","other_account_routing_scheme"],"properties":{"name":{"type":"string","example":"John Smith Ltd."},"other_account_secondary_routing_address":{"type":"string","example":"DE89370400440532013000"},"description":{"type":"string","example":"The piano lession-Invoice No:68"},"other_branch_routing_address":{"type":"string","example":"12f8a9e6-c2b1-407a-8bd0-421b7119307e"},"other_bank_routing_scheme":{"type":"string","example":"OBP"},"other_branch_routing_scheme":{"type":"string","example":"OBP"},"other_bank_routing_address":{"type":"string","example":"gh.29.uk"},"other_account_secondary_routing_scheme":{"type":"string","example":"IBAN"},"other_account_routing_address":{"type":"string","example":"DE89370400440532013000"},"other_account_routing_scheme":{"type":"string","example":"IBAN"}}},"BankRoutingJsonV121":{"required":["scheme","address"],"properties":{"scheme":{"type":"string","example":"OBP"},"address":{"type":"string","example":"gh.29.uk"}}},"AccountRoutingJsonV121":{"required":["scheme","address"],"properties":{"scheme":{"type":"string","example":"OBP"},"address":{"type":"string","example":"8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0"}}},"BranchRoutingJsonV141":{"required":["scheme","address"],"properties":{"scheme":{"type":"string","example":"OBP"},"address":{"type":"string","example":"DERBY6"}}},"ConsentRequestFromAccountJson":{"required":["bank_routing","account_routing","branch_routing"],"properties":{"bank_routing":{"$ref":"#/definitions/BankRoutingJsonV121"},"account_routing":{"$ref":"#/definitions/AccountRoutingJsonV121"},"branch_routing":{"$ref":"#/definitions/BranchRoutingJsonV141"}}},"PostCounterpartyLimitV510":{"required":["max_monthly_amount","max_number_of_monthly_transactions","max_single_amount","max_number_of_transactions","max_yearly_amount","max_total_amount","currency","max_number_of_yearly_transactions"],"properties":{"max_monthly_amount":{"type":"string","example":"10000.11"},"max_number_of_monthly_transactions":{"type":"integer","format":"int32","example":"10"},"max_single_amount":{"type":"string","example":"1000.11"},"max_number_of_transactions":{"type":"integer","format":"int32","example":"100"},"max_yearly_amount":{"type":"string","example":"12000.11"},"max_total_amount":{"type":"string","example":"10000.12"},"currency":{"type":"string","example":"EUR"},"max_number_of_yearly_transactions":{"type":"integer","format":"int32","example":"100"}}},"ConsentRequestToAccountJson":{"required":["account_routing","branch_routing","bank_routing","counterparty_name","limit"],"properties":{"account_routing":{"$ref":"#/definitions/AccountRoutingJsonV121"},"branch_routing":{"$ref":"#/definitions/BranchRoutingJsonV141"},"bank_routing":{"$ref":"#/definitions/BankRoutingJsonV121"},"counterparty_name":{"type":"string","example":"John Smith Ltd."},"limit":{"$ref":"#/definitions/PostCounterpartyLimitV510"}}},"TransactionRequestRefundTo":{"properties":{"bank_id":{"type":"string","example":"gh.29.uk"},"account_id":{"type":"string","example":"8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0"},"counterparty_id":{"type":"string","example":"9fg8a7e4-6d02-40e3-a129-0b2bf89de8uh"}}},"TransactionRequestRefundFrom":{"required":["counterparty_id"],"properties":{"counterparty_id":{"type":"string","example":"9fg8a7e4-6d02-40e3-a129-0b2bf89de8uh"}}},"RefundJson":{"required":["transaction_id","reason_code"],"properties":{"transaction_id":{"type":"string","example":"2fg8a7e4-6d02-40e3-a129-0b2bf89de8ub"},"reason_code":{"type":"string","example":"CUST"}}},"IbanJson":{"required":["iban"],"properties":{"iban":{"type":"string","example":"123"}}},"TransactionRequestReasonJsonV400":{"required":["code"],"properties":{"description":{"type":"string","example":"SEPA payment"},"amount":{"type":"string","example":"100"},"code":{"type":"string","example":"410"},"document_number":{"type":"string","example":"2020/154"},"currency":{"type":"string","example":"EUR"}}},"HistoricalTransactionAccountJsonV310":{"properties":{"bank_id":{"type":"string","example":"gh.29.uk"},"account_id":{"type":"string","example":"8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0"},"counterparty_id":{"type":"string","example":"9fg8a7e4-6d02-40e3-a129-0b2bf89de8uh"}}},"TransactionRequestAccount":{"required":["bank_id","account_id"],"properties":{"bank_id":{"type":"string","example":"String"},"account_id":{"type":"string","example":"String"}}},"AmountOfMoney":{"required":["currency","amount"],"properties":{"currency":{"type":"string","example":"EUR"},"amount":{"type":"string","example":"100"}}},"TransactionRequestBody":{"required":["to","value","description"],"properties":{"to":{"$ref":"#/definitions/TransactionRequestAccount"},"value":{"$ref":"#/definitions/AmountOfMoney"},"description":{"type":"string","example":"String"}}},"ChallengeJsonV140":{"required":["id","allowed_attempts","challenge_type"],"properties":{"id":{"type":"string","example":"be1a183d-b301-4b83-b855-5eeffdd3526f"},"allowed_attempts":{"type":"integer","format":"int32","example":"3"},"challenge_type":{"type":"string","example":"SANDBOX_TAN"}}},"TransactionRequestChargeJsonV200":{"required":["summary","value"],"properties":{"summary":{"type":"string","example":"Rent the flat"},"value":{"$ref":"#/definitions/AmountOfMoneyJsonV121"}}},"TransactionRequestIban":{"required":["iban"],"properties":{"iban":{"type":"string","example":"String"}}},"TransactionRequestCounterpartyId":{"required":["counterparty_id"],"properties":{"counterparty_id":{"type":"string","example":"9fg8a7e4-6d02-40e3-a129-0b2bf89de8uh"}}},"TransactionRequestSimple":{"required":["otherAccountSecondaryRoutingAddress","otherBankRoutingScheme","otherBranchRoutingScheme","otherAccountRoutingScheme","otherBankRoutingAddress","otherAccountRoutingAddress","otherAccountSecondaryRoutingScheme","otherBranchRoutingAddress"],"properties":{"otherAccountSecondaryRoutingAddress":{"type":"string","example":"DE91 1000 0000 0123 4567 89"},"otherBankRoutingScheme":{"type":"string","example":"BIC"},"otherBranchRoutingScheme":{"type":"string","example":"BRANCH-CODE"},"otherAccountRoutingScheme":{"type":"string","example":"IBAN"},"otherBankRoutingAddress":{"type":"string","example":"GENODEM1GLS"},"otherAccountRoutingAddress":{"type":"string","example":"DE91 1000 0000 0123 4567 89"},"otherAccountSecondaryRoutingScheme":{"type":"string","example":"IBAN"},"otherBranchRoutingAddress":{"type":"string","example":"DERBY6"}}},"FromAccountTransfer":{"required":["mobile_phone_number","nickname"],"properties":{"mobile_phone_number":{"type":"string","example":"+44 07972 444 876"},"nickname":{"type":"string","example":"String"}}},"ToAccountTransferToPhone":{"required":["mobile_phone_number"],"properties":{"mobile_phone_number":{"type":"string","example":"+44 07972 444 876"}}},"TransactionRequestTransferToPhone":{"required":["description","to","from","message","value"],"properties":{"description":{"type":"string","example":"String"},"to":{"$ref":"#/definitions/ToAccountTransferToPhone"},"from":{"$ref":"#/definitions/FromAccountTransfer"},"message":{"type":"string","example":"String"},"value":{"$ref":"#/definitions/AmountOfMoneyJsonV121"}}},"ToAccountTransferToAtmKycDocument":{"required":["type","number"],"properties":{"type":{"type":"string","example":"String"},"number":{"type":"string","example":"String"}}},"ToAccountTransferToAtm":{"required":["legal_name","date_of_birth","mobile_phone_number","kyc_document"],"properties":{"legal_name":{"type":"string","example":"Eveline Tripman"},"date_of_birth":{"type":"string","example":"20181230"},"mobile_phone_number":{"type":"string","example":"+44 07972 444 876"},"kyc_document":{"$ref":"#/definitions/ToAccountTransferToAtmKycDocument"}}},"TransactionRequestTransferToAtm":{"required":["description","to","from","message","value"],"properties":{"description":{"type":"string","example":"String"},"to":{"$ref":"#/definitions/ToAccountTransferToAtm"},"from":{"$ref":"#/definitions/FromAccountTransfer"},"message":{"type":"string","example":"String"},"value":{"$ref":"#/definitions/AmountOfMoneyJsonV121"}}},"ToAccountTransferToAccountAccount":{"required":["number","iban"],"properties":{"number":{"type":"string","example":"String"},"iban":{"type":"string","example":"String"}}},"ToAccountTransferToAccount":{"required":["name","bank_code","branch_number","account"],"properties":{"name":{"type":"string","example":"String"},"bank_code":{"type":"string","example":"String"},"branch_number":{"type":"string","example":"String"},"account":{"$ref":"#/definitions/ToAccountTransferToAccountAccount"}}},"TransactionRequestTransferToAccount":{"required":["to","transfer_type","value","description","future_date"],"properties":{"to":{"$ref":"#/definitions/ToAccountTransferToAccount"},"transfer_type":{"type":"string","example":"String"},"value":{"$ref":"#/definitions/AmountOfMoneyJsonV121"},"description":{"type":"string","example":"String"},"future_date":{"type":"string","example":"20181230"}}},"PaymentAccount":{"required":["iban"],"properties":{"iban":{"type":"string","example":"12345"}}},"SepaCreditTransfers":{"required":["debtorAccount","instructedAmount","creditorAccount","creditorName"],"properties":{"debtorAccount":{"$ref":"#/definitions/PaymentAccount"},"instructedAmount":{"$ref":"#/definitions/AmountOfMoneyJsonV121"},"creditorAccount":{"$ref":"#/definitions/PaymentAccount"},"creditorName":{"type":"string","example":"John Miles"}}},"TransactionRequestAgentCashWithdrawal":{"required":["bank_id","agent_number"],"properties":{"bank_id":{"type":"string","example":"gh.29.uk"},"agent_number":{"type":"string","example":"5987953"}}},"TransactionRequestBodyAllTypes":{"required":["description","value"],"properties":{"to_transfer_to_phone":{"$ref":"#/definitions/TransactionRequestTransferToPhone"},"to_counterparty":{"$ref":"#/definitions/TransactionRequestCounterpartyId"},"to_agent":{"$ref":"#/definitions/TransactionRequestAgentCashWithdrawal"},"to_sepa_credit_transfers":{"$ref":"#/definitions/SepaCreditTransfers"},"to_simple":{"$ref":"#/definitions/TransactionRequestSimple"},"value":{"$ref":"#/definitions/AmountOfMoney"},"to_sandbox_tan":{"$ref":"#/definitions/TransactionRequestAccount"},"description":{"type":"string","example":"Description of the object. Maximum length is 2000. It can be any characters here."},"to_transfer_to_atm":{"$ref":"#/definitions/TransactionRequestTransferToAtm"},"to_sepa":{"$ref":"#/definitions/TransactionRequestIban"},"to_transfer_to_account":{"$ref":"#/definitions/TransactionRequestTransferToAccount"}}},"ChallengeJsonV400":{"required":["allowed_attempts","user_id","id","link","challenge_type"],"properties":{"allowed_attempts":{"type":"integer","format":"int32","example":"3"},"user_id":{"type":"string","example":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1"},"id":{"type":"string","example":"2fg8a7e4-6d02-40e3-a129-0b2bf89de8ub"},"link":{"type":"string","example":"/obp/v4.0.0/banks/BANK_ID/accounts/ACCOUNT_ID/VIEW_ID/transaction-request-types/TRANSACTION_REQUEST_TYPE/transaction-requests/TRANSACTION_REQUEST_ID/challenge"},"challenge_type":{"type":"string","example":"OBP_TRANSACTION_REQUEST_CHALLENGE"}}},"BankAttributeBankResponseJsonV400":{"required":["name","value"],"properties":{"name":{"type":"string","example":"ACCOUNT_MANAGEMENT_FEE"},"value":{"type":"string","example":"5987953"}}},"TransactionRequestChargeJsonV140":{"required":["summary","value"],"properties":{"summary":{"type":"string","example":"The bank fixed charge"},"value":{"$ref":"#/definitions/AmountOfMoneyJsonV121"}}},"TransactionRequestTypeJsonV140":{"required":["value","charge"],"properties":{"value":{"type":"string","example":"10"},"charge":{"$ref":"#/definitions/TransactionRequestChargeJsonV140"}}},"TransactionRequestTypeJSONV210":{"required":["transaction_request_type"],"properties":{"transaction_request_type":{"type":"string","example":"SandboxTan"}}}}}