{"resource_docs":[{"operation_id":"OBPv2.1.0-getTransactionRequestTypesSupportedByBank","implemented_by":{"version":"OBPv2.1.0","function":"getTransactionRequestTypesSupportedByBank"},"request_verb":"GET","request_url":"/obp/v2.1.0/banks/BANK_ID/transaction-request-types","summary":"Get Transaction Request Types at Bank","description":"
Get the list of the Transaction Request Types supported by the bank.
\nAuthentication is Optional
\nURL Parameters:
\nBANK_ID: gh.29.uk
\nJSON response body fields:
\ntransaction_request_type: SEPA
\n\n","description_markdown":"Get the list of the Transaction Request Types supported by the bank.\n\nAuthentication is Optional\n\n\n**URL Parameters:**\n\n[BANK_ID](/glossary#Bank.bank_id): gh.29.uk\n\n\n\n\n\n**JSON response body fields:**\n\n\n\n[**transaction_request_type**](/glossary#): SEPA\n\n\n\n[**transaction_request_types**](/glossary#transaction_request_types): \n\n\n","example_request_body":{"jsonString":"{}"},"success_response_body":{"transaction_request_types":[{"transaction_request_type":"SandboxTan"}]},"error_response_bodies":["OBP-50000: Unknown Error."],"tags":["Transaction-Request","Bank"],"typed_request_body":{"type":"object","properties":{"jsonString":{"type":"string"}}},"typed_success_response_body":{"type":"object","properties":{"transaction_request_types":{"type":"array","items":{"type":"object","properties":{"transaction_request_type":{"type":"string"}}}}}},"is_featured":false,"special_instructions":"","specified_url":"/obp/v4.0.0/banks/BANK_ID/transaction-request-types","connector_methods":[]},{"operation_id":"OBPv3.1.0-getTransactionRequests","implemented_by":{"version":"OBPv3.1.0","function":"getTransactionRequests"},"request_verb":"GET","request_url":"/obp/v3.1.0/banks/BANK_ID/accounts/ACCOUNT_ID/VIEW_ID/transaction-requests","summary":"Get Transaction Requests","description":"Returns transaction requests for account specified by ACCOUNT_ID at bank specified by BANK_ID.
\nThe VIEW_ID specified must be 'owner' and the user must have access to this view.
\nVersion 2.0.0 now returns charge information.
\nTransaction Requests serve to initiate transactions that may or may not proceed. They contain information including:
\nPSD2 Context: PSD2 requires transparency of charges to the customer.
\nThis endpoint provides the charge that would be applied if the Transaction Request proceeds - and a record of that charge there after.
\nThe customer can proceed with the Transaction by answering the security challenge.
Authentication is Mandatory
\nURL Parameters:
\nACCOUNT_ID: 8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0
\nBANK_ID: gh.29.uk
\nVIEW_ID: owner
\nJSON response body fields:
\n\naccount_id: 8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0
\n\namount: 10.12
\nbank_code: CGHZ
\nbank_id: gh.29.uk
\n\n\n\n\ncounterparty_id: 9fg8a7e4-6d02-40e3-a129-0b2bf89de8uh
\n\n\ncurrency: EUR
\ndate_of_birth: 2018-03-09
\n\ndescription: This an optional field. Maximum length is 2000. It can be any characters here.
\n\n\nfrom:
\nfuture_date: 20200127
\niban: DE91 1000 0000 0123 4567 89
\nid: d8839721-ad8f-45dd-9f78-2080414b93f9
\ninstructedAmount: 100
\n\nlegal_name: Eveline Tripman
\nmessage: 123456
\nmobile_phone_number: +49 30 901820
\nname: ACCOUNT_MANAGEMENT_FEE
\n\n\notherAccountRoutingAddress: otherAccountRoutingAddress
\notherAccountRoutingScheme: otherAccountRoutingScheme
\notherAccountSecondaryRoutingAddress: otherAccountSecondaryRoutingAddress
\notherAccountSecondaryRoutingScheme: otherAccountSecondaryRoutingScheme
\notherBankRoutingAddress: otherBankRoutingAddress
\notherBankRoutingScheme: otherBankRoutingScheme
\notherBranchRoutingAddress: otherBranchRoutingAddress
\notherBranchRoutingScheme: otherBranchRoutingScheme
\nstart_date: 2020-01-27
\n\n\nto:
\n\ntransaction_requests_with_charges:
\n\ntype:
\nvalue: 5987953
\n\n\n\n\nto_simple: to_simple
\n\n\n\n","description_markdown":"Returns transaction requests for account specified by ACCOUNT_ID at bank specified by BANK_ID.\n\nThe VIEW_ID specified must be 'owner' and the user must have access to this view.\n\nVersion 2.0.0 now returns charge information.\n\nTransaction Requests serve to initiate transactions that may or may not proceed. They contain information including:\n\n* Transaction Request Id\n* Type\n* Status (INITIATED, COMPLETED)\n* Challenge (in order to confirm the request)\n* From Bank / Account\n* Details including Currency, Value, Description and other initiation information specific to each type. (Could potentialy include a list of future transactions.)\n* Related Transactions\n\nPSD2 Context: PSD2 requires transparency of charges to the customer.\nThis endpoint provides the charge that would be applied if the Transaction Request proceeds - and a record of that charge there after.\nThe customer can proceed with the Transaction by answering the security challenge.\n\n \n\nAuthentication is Mandatory\n\n\n**URL Parameters:**\n\n[ACCOUNT_ID](/glossary#Account.account_id): 8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0\n\n\n\n[BANK_ID](/glossary#Bank.bank_id): gh.29.uk\n\n\n\n[VIEW_ID](/glossary#this_view_id): owner\n\n\n\n\n\n**JSON response body fields:**\n\n\n\n[**account**](/glossary#Account): \n\n\n\n[**account_id**](/glossary#): 8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0\n\n\n\n[**allowed_attempts**](/glossary#allowed_attempts): 5\n\n\n\n[**amount**](/glossary#): 10.12\n\n\n\n[**bank_code**](/glossary#bank_code): CGHZ\n\n\n\n[**bank_id**](/glossary#): gh.29.uk\n\n\n\n[**branch_number**](/glossary#branch_number): \n\n\n\n[**challenge**](/glossary#challenge): \n\n\n\n[**challenge_type**](/glossary#challenge_type): \n\n\n\n[**charge**](/glossary#charge): \n\n\n\n[**counterparty_id**](/glossary#): 9fg8a7e4-6d02-40e3-a129-0b2bf89de8uh\n\n\n\n[**creditorAccount**](/glossary#creditoraccount): \n\n\n\n[**creditorName**](/glossary#creditorname): \n\n\n\n[**currency**](/glossary#): EUR\n\n\n\n[**date_of_birth**](/glossary#): 2018-03-09\n\n\n\n[**debtorAccount**](/glossary#debtoraccount): \n\n\n\n[**description**](/glossary#description): This an optional field. Maximum length is 2000. It can be any characters here.\n\n\n\n[**details**](/glossary#details): \n\n\n\n[**end_date**](/glossary#end_date): \n\n\n\n[**from**](/glossary#from): \n\n\n\n[**future_date**](/glossary#future_date): 20200127\n\n\n\n[**iban**](/glossary#): DE91 1000 0000 0123 4567 89\n\n\n\n[**id**](/glossary#id): d8839721-ad8f-45dd-9f78-2080414b93f9\n\n\n\n[**instructedAmount**](/glossary#instructedamount): 100\n\n\n\n[**kyc_document**](/glossary#kyc_document): \n\n\n\n[**legal_name**](/glossary#): Eveline Tripman\n\n\n\n[**message**](/glossary#message): 123456\n\n\n\n[**mobile_phone_number**](/glossary#mobile_phone_number): +49 30 901820\n\n\n\n[**name**](/glossary#name): ACCOUNT_MANAGEMENT_FEE\n\n\n\n[**nickname**](/glossary#nickname): \n\n\n\n[**number**](/glossary#number): \n\n\n\n[**otherAccountRoutingAddress**](/glossary#): otherAccountRoutingAddress\n\n\n\n[**otherAccountRoutingScheme**](/glossary#): otherAccountRoutingScheme\n\n\n\n[**otherAccountSecondaryRoutingAddress**](/glossary#): otherAccountSecondaryRoutingAddress\n\n\n\n[**otherAccountSecondaryRoutingScheme**](/glossary#): otherAccountSecondaryRoutingScheme\n\n\n\n[**otherBankRoutingAddress**](/glossary#): otherBankRoutingAddress\n\n\n\n[**otherBankRoutingScheme**](/glossary#): otherBankRoutingScheme\n\n\n\n[**otherBranchRoutingAddress**](/glossary#): otherBranchRoutingAddress\n\n\n\n[**otherBranchRoutingScheme**](/glossary#): otherBranchRoutingScheme\n\n\n\n[**start_date**](/glossary#): 2020-01-27\n\n\n\n[**status**](/glossary#status): \n\n\n\n[**summary**](/glossary#summary): \n\n\n\n[**to**](/glossary#to): \n\n\n\n[**transaction_ids**](/glossary#transaction_ids): \n\n\n\n[**transaction_requests_with_charges**](/glossary#transaction_requests_with_charges): \n\n\n\n[**transfer_type**](/glossary#transfer_type): \n\n\n\n[**type**](/glossary#type): \n\n\n\n[**value**](/glossary#): 5987953\n\n\n\n[to_counterparty](/glossary#to_counterparty): \n\n\n\n[to_sandbox_tan](/glossary#to_sandbox_tan): \n\n\n\n[to_sepa](/glossary#to_sepa): \n\n\n\n[to_sepa_credit_transfers](/glossary#to_sepa_credit_transfers): \n\n\n\n[to_simple](/glossary#): to_simple\n\n\n\n[to_transfer_to_account](/glossary#to_transfer_to_account): \n\n\n\n[to_transfer_to_atm](/glossary#to_transfer_to_atm): \n\n\n\n[to_transfer_to_phone](/glossary#to_transfer_to_phone): \n\n\n","success_response_body":{"transaction_requests_with_charges":[{"id":"4050046c-63b3-4868-8a22-14b4181d33a6","type":"SANDBOX_TAN","from":{"bank_id":"gh.29.uk","account_id":"8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0"},"details":{"to_sandbox_tan":{"bank_id":"String","account_id":"String"},"to_sepa":{"iban":"String"},"to_counterparty":{"counterparty_id":"9fg8a7e4-6d02-40e3-a129-0b2bf89de8uh"},"to_simple":{"otherBankRoutingScheme":"BIC","otherBankRoutingAddress":"GENODEM1GLS","otherBranchRoutingScheme":"BRANCH-CODE","otherBranchRoutingAddress":"DERBY6","otherAccountRoutingScheme":"IBAN","otherAccountRoutingAddress":"DE91 1000 0000 0123 4567 89","otherAccountSecondaryRoutingScheme":"IBAN","otherAccountSecondaryRoutingAddress":"DE91 1000 0000 0123 4567 89"},"to_transfer_to_phone":{"value":{"currency":"EUR","amount":"0"},"description":"String","message":"String","from":{"mobile_phone_number":"+44 07972 444 876","nickname":"String"},"to":{"mobile_phone_number":"+44 07972 444 876"}},"to_transfer_to_atm":{"value":{"currency":"EUR","amount":"0"},"description":"String","message":"String","from":{"mobile_phone_number":"+44 07972 444 876","nickname":"String"},"to":{"legal_name":"Eveline Tripman","date_of_birth":"20181230","mobile_phone_number":"+44 07972 444 876","kyc_document":{"type":"String","number":"String"}}},"to_transfer_to_account":{"value":{"currency":"EUR","amount":"0"},"description":"String","transfer_type":"String","future_date":"20181230","to":{"name":"String","bank_code":"String","branch_number":"String","account":{"number":"String","iban":"String"}}},"to_sepa_credit_transfers":{"debtorAccount":{"iban":"12345"},"instructedAmount":{"currency":"EUR","amount":"0"},"creditorAccount":{"iban":"54321"},"creditorName":"John Miles"},"value":{"currency":"EUR","amount":"100"},"description":"This an optional field. Maximum length is 2000. It can be any characters here."},"transaction_ids":["902ba3bb-dedd-45e7-9319-2fd3f2cd98a1"],"status":"COMPLETED","start_date":"1100-01-01T00:00:00Z","end_date":"1100-01-01T00:00:00Z","challenge":{"id":"be1a183d-b301-4b83-b855-5eeffdd3526f","allowed_attempts":3,"challenge_type":"SANDBOX_TAN"},"charge":{"summary":"Rent the flat","value":{"currency":"EUR","amount":"0"}}}]},"error_response_bodies":["OBP-20001: User not logged in. Authentication is required!","OBP-30001: Bank not found. Please specify a valid value for BANK_ID.","OBP-30018: Bank Account not found. Please specify valid values for BANK_ID and ACCOUNT_ID. ","OBP-20017: Current user does not have access to the view. Please specify a valid value for VIEW_ID.","OBP-20022: View does not permit the access.","OBP-60010: Get Transaction Requests Exception. ","OBP-50000: Unknown Error."],"tags":["Transaction-Request","Payment Initiation Service (PIS)"],"typed_success_response_body":{"type":"object","properties":{"transaction_requests_with_charges":{"type":"array","items":{"type":"object","properties":{"type":{"type":"string"},"challenge":{"type":"object","properties":{"challenge_type":{"type":"string"},"allowed_attempts":{"type":"integer"},"id":{"type":"string"}}},"status":{"type":"string"},"end_date":{"type":"string","format":"date-time"},"charge":{"type":"object","properties":{"summary":{"type":"string"},"value":{"type":"object","properties":{"currency":{"type":"string"},"amount":{"type":"string"}}}}},"transaction_ids":{"type":"array","items":{"type":"string"}},"from":{"type":"object","properties":{"bank_id":{"type":"string"},"account_id":{"type":"string"}}},"details":{"type":"object","properties":{"description":{"type":"string"},"to_sandbox_tan":{"type":"object","properties":{"account_id":{"type":"string"},"bank_id":{"type":"string"}}},"value":{"type":"object","properties":{"currency":{"type":"string"},"amount":{"type":"string"}}},"to_transfer_to_phone":{"type":"object","properties":{"description":{"type":"string"},"message":{"type":"string"},"from":{"type":"object","properties":{"nickname":{"type":"string"},"mobile_phone_number":{"type":"string"}}},"to":{"type":"object","properties":{"mobile_phone_number":{"type":"string"}}},"value":{"type":"object","properties":{"currency":{"type":"string"},"amount":{"type":"string"}}}}},"to_sepa":{"type":"object","properties":{"iban":{"type":"string"}}},"to_simple":{"type":"object","properties":{"otherBankRoutingAddress":{"type":"string"},"otherAccountSecondaryRoutingAddress":{"type":"string"},"otherBranchRoutingScheme":{"type":"string"},"otherAccountRoutingScheme":{"type":"string"},"otherAccountRoutingAddress":{"type":"string"},"otherBankRoutingScheme":{"type":"string"},"otherBranchRoutingAddress":{"type":"string"},"otherAccountSecondaryRoutingScheme":{"type":"string"}}},"to_counterparty":{"type":"object","properties":{"counterparty_id":{"type":"string"}}},"to_transfer_to_account":{"type":"object","properties":{"to":{"type":"object","properties":{"name":{"type":"string"},"account":{"type":"object","properties":{"number":{"type":"string"},"iban":{"type":"string"}}},"bank_code":{"type":"string"},"branch_number":{"type":"string"}}},"transfer_type":{"type":"string"},"description":{"type":"string"},"future_date":{"type":"string"},"value":{"type":"object","properties":{"currency":{"type":"string"},"amount":{"type":"string"}}}}},"to_sepa_credit_transfers":{"type":"object","properties":{"instructedAmount":{"type":"object","properties":{"currency":{"type":"string"},"amount":{"type":"string"}}},"debtorAccount":{"type":"object","properties":{"iban":{"type":"string"}}},"creditorAccount":{"type":"object","properties":{"iban":{"type":"string"}}},"creditorName":{"type":"string"}}},"to_transfer_to_atm":{"type":"object","properties":{"description":{"type":"string"},"message":{"type":"string"},"from":{"type":"object","properties":{"nickname":{"type":"string"},"mobile_phone_number":{"type":"string"}}},"value":{"type":"object","properties":{"currency":{"type":"string"},"amount":{"type":"string"}}},"to":{"type":"object","properties":{"date_of_birth":{"type":"string"},"kyc_document":{"type":"object","properties":{"type":{"type":"string"},"number":{"type":"string"}}},"legal_name":{"type":"string"},"mobile_phone_number":{"type":"string"}}}}}}},"start_date":{"type":"string","format":"date-time"},"id":{"type":"string"}}}}}},"is_featured":false,"special_instructions":"","specified_url":"/obp/v4.0.0/banks/BANK_ID/accounts/ACCOUNT_ID/VIEW_ID/transaction-requests","connector_methods":[]},{"operation_id":"OBPv4.0.0-createTransactionRequestCard","implemented_by":{"version":"OBPv4.0.0","function":"createTransactionRequestCard"},"request_verb":"POST","request_url":"/obp/v4.0.0/transaction-request-types/CARD/transaction-requests","summary":"Create Transaction Request (CARD)","description":"When using CARD, the payee is set in the request body .
\nMoney goes into the Counterparty in the request body.
\nInitiate a Payment via creating a Transaction Request.
\nIn OBP, a transaction request
may or may not result in a transaction
. However, a transaction
only has one possible state: completed.
A Transaction Request
can have one of several states: INITIATED, NEXT_CHALLENGE_PENDING etc.
Transactions
are modeled on items in a bank statement that represent the movement of money.
Transaction Requests
are requests to move money which may or may not succeed and thus result in a Transaction
.
A Transaction Request
might create a security challenge that needs to be answered before the Transaction Request
proceeds.
\nIn case 1 person needs to answer security challenge we have next flow of state of an transaction request
:
\nINITIATED => COMPLETED
\nIn case n persons needs to answer security challenge we have next flow of state of an transaction request
:
\nINITIATED => NEXT_CHALLENGE_PENDING => ... => NEXT_CHALLENGE_PENDING => COMPLETED
The security challenge is bound to a user i.e. in case of right answer and the user is different than expected one the challenge will fail.
\nRule for calculating number of security challenges:
\nIf product Account attribute REQUIRED_CHALLENGE_ANSWERS=N then create N challenges
\n(one for every user that has a View where permission "can_add_transaction_request_to_any_account"=true)
\nIn case REQUIRED_CHALLENGE_ANSWERS is not defined as an account attribute default value is 1.
Transaction Requests contain charge information giving the client the opportunity to proceed or not (as long as the challenge level is appropriate).
\nTransaction Requests can have one of several Transaction Request Types which expect different bodies. The escaped body is returned in the details key of the GET response.
\nThis provides some commonality and one URL for many different payment or transfer types with enough flexibility to validate them differently.
The payer is set in the URL. Money comes out of the BANK_ID and ACCOUNT_ID specified in the URL.
\nIn sandbox mode, TRANSACTION_REQUEST_TYPE is commonly set to ACCOUNT. See getTransactionRequestTypesSupportedByBank for all supported types.
\nIn sandbox mode, if the amount is less than 1000 EUR (any currency, unless it is set differently on this server), the transaction request will create a transaction without a challenge, else the Transaction Request will be set to INITIALISED and a challenge will need to be answered.
\nIf a challenge is created you must answer it using Answer Transaction Request Challenge before the Transaction is created.
\nYou can transfer between different currency accounts. (new in 2.0.0). The currency in body must match the sending account.
\nThe following static FX rates are available in sandbox mode:
\n\nTransaction Requests satisfy PSD2 requirements thus:
\n1) A transaction can be initiated by a third party application.
\n2) The customer is informed of the charge that will incurred.
\n3) The call supports delegated authentication (OAuth)
\nSee this python code for a complete example of this flow.
\nThere is further documentation here
\nAuthentication is Mandatory
\nURL Parameters:
\nCARD: CARD
\nJSON request body fields:
\namount: 10.12
\nbrand: Visa
\ncard: card
\ncard_number: 364435172576215
\ncard_type: Credit
\ncounterparty_id: 9fg8a7e4-6d02-40e3-a129-0b2bf89de8uh
\ncurrency: EUR
\ncvv: 123
\ndescription: This an optional field. Maximum length is 2000. It can be any characters here.
\nexpiry_month: 01
\nexpiry_year: 2023
\nname_on_card: SusanSmith
\nto:
\nvalue: 5987953
\nJSON response body fields:
\n\naccount_id: 8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0
\n\namount: 10.12
\nbank_code: CGHZ
\nbank_id: gh.29.uk
\n\n\nchallenges: challenges
\n\ncounterparty_id: 9fg8a7e4-6d02-40e3-a129-0b2bf89de8uh
\n\n\ncurrency: EUR
\ndate_of_birth: 2018-03-09
\n\ndescription: This an optional field. Maximum length is 2000. It can be any characters here.
\n\n\nfrom:
\nfuture_date: 20200127
\niban: DE91 1000 0000 0123 4567 89
\nid: d8839721-ad8f-45dd-9f78-2080414b93f9
\ninstructedAmount: 100
\n\nlegal_name: Eveline Tripman
\nlink:
\nmessage: 123456
\nmobile_phone_number: +49 30 901820
\nname: ACCOUNT_MANAGEMENT_FEE
\n\n\notherAccountRoutingAddress: otherAccountRoutingAddress
\notherAccountRoutingScheme: otherAccountRoutingScheme
\notherAccountSecondaryRoutingAddress: otherAccountSecondaryRoutingAddress
\notherAccountSecondaryRoutingScheme: otherAccountSecondaryRoutingScheme
\notherBankRoutingAddress: otherBankRoutingAddress
\notherBankRoutingScheme: otherBankRoutingScheme
\notherBranchRoutingAddress: otherBranchRoutingAddress
\notherBranchRoutingScheme: otherBranchRoutingScheme
\nstart_date: 2020-01-27
\n\n\nto:
\n\n\ntype:
\nuser_id: 9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1
\nvalue: 5987953
\n\n\n\n\nto_simple: to_simple
\n\n\n\n","description_markdown":"When using CARD, the payee is set in the request body .\n\nMoney goes into the Counterparty in the request body.\n\nInitiate a Payment via creating a Transaction Request.\n\nIn OBP, a `transaction request` may or may not result in a `transaction`. However, a `transaction` only has one possible state: completed.\n\nA `Transaction Request` can have one of several states: INITIATED, NEXT_CHALLENGE_PENDING etc.\n\n`Transactions` are modeled on items in a bank statement that represent the movement of money.\n\n`Transaction Requests` are requests to move money which may or may not succeed and thus result in a `Transaction`.\n\nA `Transaction Request` might create a security challenge that needs to be answered before the `Transaction Request` proceeds.\nIn case 1 person needs to answer security challenge we have next flow of state of an `transaction request`:\n INITIATED => COMPLETED\nIn case n persons needs to answer security challenge we have next flow of state of an `transaction request`:\n INITIATED => NEXT_CHALLENGE_PENDING => ... => NEXT_CHALLENGE_PENDING => COMPLETED\n\nThe security challenge is bound to a user i.e. in case of right answer and the user is different than expected one the challenge will fail.\n\nRule for calculating number of security challenges:\nIf product Account attribute REQUIRED_CHALLENGE_ANSWERS=N then create N challenges\n(one for every user that has a View where permission \"can_add_transaction_request_to_any_account\"=true)\nIn case REQUIRED_CHALLENGE_ANSWERS is not defined as an account attribute default value is 1.\n\nTransaction Requests contain charge information giving the client the opportunity to proceed or not (as long as the challenge level is appropriate).\n\nTransaction Requests can have one of several Transaction Request Types which expect different bodies. The escaped body is returned in the details key of the GET response.\nThis provides some commonality and one URL for many different payment or transfer types with enough flexibility to validate them differently.\n\nThe payer is set in the URL. Money comes out of the BANK_ID and ACCOUNT_ID specified in the URL.\n\nIn sandbox mode, TRANSACTION_REQUEST_TYPE is commonly set to ACCOUNT. See getTransactionRequestTypesSupportedByBank for all supported types.\n\nIn sandbox mode, if the amount is less than 1000 EUR (any currency, unless it is set differently on this server), the transaction request will create a transaction without a challenge, else the Transaction Request will be set to INITIALISED and a challenge will need to be answered.\n\nIf a challenge is created you must answer it using Answer Transaction Request Challenge before the Transaction is created.\n\nYou can transfer between different currency accounts. (new in 2.0.0). The currency in body must match the sending account.\n\nThe following static FX rates are available in sandbox mode:\n\nhttps://apiexplorer-ii-sandbox.openbankproject.com//more?version=OBPv4.0.0&list-all-banks=false&core=&psd2=&obwg=#OBPv2_2_0-getCurrentFxRate\n\n\nTransaction Requests satisfy PSD2 requirements thus:\n\n1) A transaction can be initiated by a third party application.\n\n2) The customer is informed of the charge that will incurred.\n\n3) The call supports delegated authentication (OAuth)\n\nSee [this python code](https://github.com/OpenBankProject/Hello-OBP-DirectLogin-Python/blob/master/hello_payments.py) for a complete example of this flow.\n\nThere is further documentation [here](https://github.com/OpenBankProject/OBP-API/wiki/Transaction-Requests)\n\n\n\n \n\nAuthentication is Mandatory\n\n\n**URL Parameters:**\n\n[CARD](/glossary#): CARD\n\n\n\n\n\n**JSON request body fields:**\n\n\n\n[**amount**](/glossary#): 10.12\n\n\n\n[**brand**](/glossary#): Visa\n\n\n\n[**card**](/glossary#): card\n\n\n\n[**card_number**](/glossary#): 364435172576215\n\n\n\n[**card_type**](/glossary#): Credit\n\n\n\n[**counterparty_id**](/glossary#): 9fg8a7e4-6d02-40e3-a129-0b2bf89de8uh\n\n\n\n[**currency**](/glossary#): EUR\n\n\n\n[**cvv**](/glossary#): 123\n\n\n\n[**description**](/glossary#description): This an optional field. Maximum length is 2000. It can be any characters here.\n\n\n\n[**expiry_month**](/glossary#): 01\n\n\n\n[**expiry_year**](/glossary#): 2023\n\n\n\n[**name_on_card**](/glossary#): SusanSmith\n\n\n\n[**to**](/glossary#to): \n\n\n\n[**value**](/glossary#): 5987953\n\n\n\n\n\n**JSON response body fields:**\n\n\n\n[**account**](/glossary#Account): \n\n\n\n[**account_id**](/glossary#): 8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0\n\n\n\n[**allowed_attempts**](/glossary#allowed_attempts): 5\n\n\n\n[**amount**](/glossary#): 10.12\n\n\n\n[**bank_code**](/glossary#bank_code): CGHZ\n\n\n\n[**bank_id**](/glossary#): gh.29.uk\n\n\n\n[**branch_number**](/glossary#branch_number): \n\n\n\n[**challenge_type**](/glossary#challenge_type): \n\n\n\n[**challenges**](/glossary#): challenges\n\n\n\n[**charge**](/glossary#charge): \n\n\n\n[**counterparty_id**](/glossary#): 9fg8a7e4-6d02-40e3-a129-0b2bf89de8uh\n\n\n\n[**creditorAccount**](/glossary#creditoraccount): \n\n\n\n[**creditorName**](/glossary#creditorname): \n\n\n\n[**currency**](/glossary#): EUR\n\n\n\n[**date_of_birth**](/glossary#): 2018-03-09\n\n\n\n[**debtorAccount**](/glossary#debtoraccount): \n\n\n\n[**description**](/glossary#description): This an optional field. Maximum length is 2000. It can be any characters here.\n\n\n\n[**details**](/glossary#details): \n\n\n\n[**end_date**](/glossary#end_date): \n\n\n\n[**from**](/glossary#from): \n\n\n\n[**future_date**](/glossary#future_date): 20200127\n\n\n\n[**iban**](/glossary#): DE91 1000 0000 0123 4567 89\n\n\n\n[**id**](/glossary#id): d8839721-ad8f-45dd-9f78-2080414b93f9\n\n\n\n[**instructedAmount**](/glossary#instructedamount): 100\n\n\n\n[**kyc_document**](/glossary#kyc_document): \n\n\n\n[**legal_name**](/glossary#): Eveline Tripman\n\n\n\n[**link**](/glossary#link): \n\n\n\n[**message**](/glossary#message): 123456\n\n\n\n[**mobile_phone_number**](/glossary#mobile_phone_number): +49 30 901820\n\n\n\n[**name**](/glossary#name): ACCOUNT_MANAGEMENT_FEE\n\n\n\n[**nickname**](/glossary#nickname): \n\n\n\n[**number**](/glossary#number): \n\n\n\n[**otherAccountRoutingAddress**](/glossary#): otherAccountRoutingAddress\n\n\n\n[**otherAccountRoutingScheme**](/glossary#): otherAccountRoutingScheme\n\n\n\n[**otherAccountSecondaryRoutingAddress**](/glossary#): otherAccountSecondaryRoutingAddress\n\n\n\n[**otherAccountSecondaryRoutingScheme**](/glossary#): otherAccountSecondaryRoutingScheme\n\n\n\n[**otherBankRoutingAddress**](/glossary#): otherBankRoutingAddress\n\n\n\n[**otherBankRoutingScheme**](/glossary#): otherBankRoutingScheme\n\n\n\n[**otherBranchRoutingAddress**](/glossary#): otherBranchRoutingAddress\n\n\n\n[**otherBranchRoutingScheme**](/glossary#): otherBranchRoutingScheme\n\n\n\n[**start_date**](/glossary#): 2020-01-27\n\n\n\n[**status**](/glossary#status): \n\n\n\n[**summary**](/glossary#summary): \n\n\n\n[**to**](/glossary#to): \n\n\n\n[**transaction_ids**](/glossary#transaction_ids): \n\n\n\n[**transfer_type**](/glossary#transfer_type): \n\n\n\n[**type**](/glossary#type): \n\n\n\n[**user_id**](/glossary#): 9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1\n\n\n\n[**value**](/glossary#): 5987953\n\n\n\n[to_counterparty](/glossary#to_counterparty): \n\n\n\n[to_sandbox_tan](/glossary#to_sandbox_tan): \n\n\n\n[to_sepa](/glossary#to_sepa): \n\n\n\n[to_sepa_credit_transfers](/glossary#to_sepa_credit_transfers): \n\n\n\n[to_simple](/glossary#): to_simple\n\n\n\n[to_transfer_to_account](/glossary#to_transfer_to_account): \n\n\n\n[to_transfer_to_atm](/glossary#to_transfer_to_atm): \n\n\n\n[to_transfer_to_phone](/glossary#to_transfer_to_phone): \n\n\n","example_request_body":{"card":{"card_type":"Credit","brand":"Visa","cvv":"123","card_number":"364435172576215","name_on_card":"SusanSmith","expiry_year":"2023","expiry_month":"01"},"to":{"counterparty_id":"9fg8a7e4-6d02-40e3-a129-0b2bf89de8uh"},"value":{"currency":"EUR","amount":"0"},"description":"A card payment description. "},"success_response_body":{"id":"4050046c-63b3-4868-8a22-14b4181d33a6","type":"SANDBOX_TAN","from":{"bank_id":"gh.29.uk","account_id":"8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0"},"details":{"to_sandbox_tan":{"bank_id":"String","account_id":"String"},"to_sepa":{"iban":"String"},"to_counterparty":{"counterparty_id":"9fg8a7e4-6d02-40e3-a129-0b2bf89de8uh"},"to_simple":{"otherBankRoutingScheme":"BIC","otherBankRoutingAddress":"GENODEM1GLS","otherBranchRoutingScheme":"BRANCH-CODE","otherBranchRoutingAddress":"DERBY6","otherAccountRoutingScheme":"IBAN","otherAccountRoutingAddress":"DE91 1000 0000 0123 4567 89","otherAccountSecondaryRoutingScheme":"IBAN","otherAccountSecondaryRoutingAddress":"DE91 1000 0000 0123 4567 89"},"to_transfer_to_phone":{"value":{"currency":"EUR","amount":"0"},"description":"String","message":"String","from":{"mobile_phone_number":"+44 07972 444 876","nickname":"String"},"to":{"mobile_phone_number":"+44 07972 444 876"}},"to_transfer_to_atm":{"value":{"currency":"EUR","amount":"0"},"description":"String","message":"String","from":{"mobile_phone_number":"+44 07972 444 876","nickname":"String"},"to":{"legal_name":"Eveline Tripman","date_of_birth":"20181230","mobile_phone_number":"+44 07972 444 876","kyc_document":{"type":"String","number":"String"}}},"to_transfer_to_account":{"value":{"currency":"EUR","amount":"0"},"description":"String","transfer_type":"String","future_date":"20181230","to":{"name":"String","bank_code":"String","branch_number":"String","account":{"number":"String","iban":"String"}}},"to_sepa_credit_transfers":{"debtorAccount":{"iban":"12345"},"instructedAmount":{"currency":"EUR","amount":"0"},"creditorAccount":{"iban":"54321"},"creditorName":"John Miles"},"value":{"currency":"EUR","amount":"100"},"description":"This an optional field. Maximum length is 2000. It can be any characters here."},"transaction_ids":["902ba3bb-dedd-45e7-9319-2fd3f2cd98a1"],"status":"COMPLETED","start_date":"1100-01-01T00:00:00Z","end_date":"1100-01-01T00:00:00Z","challenges":[{"id":"2fg8a7e4-6d02-40e3-a129-0b2bf89de8ub","user_id":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1","allowed_attempts":3,"challenge_type":"OBP_TRANSACTION_REQUEST_CHALLENGE","link":"/obp/v4.0.0/banks/BANK_ID/accounts/ACCOUNT_ID/VIEW_ID/transaction-request-types/TRANSACTION_REQUEST_TYPE/transaction-requests/TRANSACTION_REQUEST_ID/challenge"}],"charge":{"summary":"Rent the flat","value":{"currency":"EUR","amount":"0"}}},"error_response_bodies":["OBP-20001: User not logged in. Authentication is required!","OBP-30111: Invalid Bank Id. The BANK_ID should only contain 0-9/a-z/A-Z/'-'/'.'/'_', the length should be smaller than 255.","OBP-30110: Invalid Account Id. The ACCOUNT_ID should only contain 0-9/a-z/A-Z/'-'/'.'/'_', the length should be smaller than 255.","OBP-10001: Incorrect json format.","OBP-30001: Bank not found. Please specify a valid value for BANK_ID.","OBP-30003: Account not found. Please specify a valid value for ACCOUNT_ID.","OBP-30018: Bank Account not found. Please specify valid values for BANK_ID and ACCOUNT_ID. ","OBP-40002: Insufficient authorisation to create TransactionRequest. The Transaction Request could not be created because the login user doesn't have access to the view of the from account or the consumer doesn't have the access to the view of the from account or the login user does not have the `CanCreateAnyTransactionRequest` role or the view does not have the permission canaddtransactionrequesttoanyaccount.","OBP-40001: Invalid value for TRANSACTION_REQUEST_TYPE","OBP-10001: Incorrect json format.","OBP-10002: Invalid Number. Could not convert value to a number.","OBP-40008: Can't send a payment with a value of 0 or less.","OBP-40003: Transaction Request Currency must be the same as From Account Currency.","OBP-00003: Transaction Requests is disabled in this API instance.","OBP-50000: Unknown Error."],"tags":["Transaction-Request","Payment Initiation Service (PIS)","PSD2"],"typed_request_body":{"type":"object","properties":{"description":{"type":"string"},"value":{"type":"object","properties":{"currency":{"type":"string"},"amount":{"type":"string"}}},"card":{"type":"object","properties":{"card_number":{"type":"string"},"cvv":{"type":"string"},"card_type":{"type":"string"},"name_on_card":{"type":"string"},"brand":{"type":"string"},"expiry_month":{"type":"string"},"expiry_year":{"type":"string"}}},"to":{"type":"object","properties":{"counterparty_id":{"type":"string"}}}}},"typed_success_response_body":{"type":"object","properties":{"type":{"type":"string"},"challenges":{"type":"array","items":{"type":"object","properties":{"challenge_type":{"type":"string"},"link":{"type":"string"},"id":{"type":"string"},"allowed_attempts":{"type":"integer"},"user_id":{"type":"string"}}}},"status":{"type":"string"},"end_date":{"type":"string","format":"date-time"},"charge":{"type":"object","properties":{"summary":{"type":"string"},"value":{"type":"object","properties":{"currency":{"type":"string"},"amount":{"type":"string"}}}}},"transaction_ids":{"type":"array","items":{"type":"string"}},"from":{"type":"object","properties":{"bank_id":{"type":"string"},"account_id":{"type":"string"}}},"details":{"type":"object","properties":{"description":{"type":"string"},"to_sandbox_tan":{"type":"object","properties":{"account_id":{"type":"string"},"bank_id":{"type":"string"}}},"value":{"type":"object","properties":{"currency":{"type":"string"},"amount":{"type":"string"}}},"to_transfer_to_phone":{"type":"object","properties":{"description":{"type":"string"},"message":{"type":"string"},"from":{"type":"object","properties":{"nickname":{"type":"string"},"mobile_phone_number":{"type":"string"}}},"to":{"type":"object","properties":{"mobile_phone_number":{"type":"string"}}},"value":{"type":"object","properties":{"currency":{"type":"string"},"amount":{"type":"string"}}}}},"to_sepa":{"type":"object","properties":{"iban":{"type":"string"}}},"to_simple":{"type":"object","properties":{"otherBankRoutingAddress":{"type":"string"},"otherAccountSecondaryRoutingAddress":{"type":"string"},"otherBranchRoutingScheme":{"type":"string"},"otherAccountRoutingScheme":{"type":"string"},"otherAccountRoutingAddress":{"type":"string"},"otherBankRoutingScheme":{"type":"string"},"otherBranchRoutingAddress":{"type":"string"},"otherAccountSecondaryRoutingScheme":{"type":"string"}}},"to_counterparty":{"type":"object","properties":{"counterparty_id":{"type":"string"}}},"to_transfer_to_account":{"type":"object","properties":{"to":{"type":"object","properties":{"name":{"type":"string"},"account":{"type":"object","properties":{"number":{"type":"string"},"iban":{"type":"string"}}},"bank_code":{"type":"string"},"branch_number":{"type":"string"}}},"transfer_type":{"type":"string"},"description":{"type":"string"},"future_date":{"type":"string"},"value":{"type":"object","properties":{"currency":{"type":"string"},"amount":{"type":"string"}}}}},"to_sepa_credit_transfers":{"type":"object","properties":{"instructedAmount":{"type":"object","properties":{"currency":{"type":"string"},"amount":{"type":"string"}}},"debtorAccount":{"type":"object","properties":{"iban":{"type":"string"}}},"creditorAccount":{"type":"object","properties":{"iban":{"type":"string"}}},"creditorName":{"type":"string"}}},"to_transfer_to_atm":{"type":"object","properties":{"description":{"type":"string"},"message":{"type":"string"},"from":{"type":"object","properties":{"nickname":{"type":"string"},"mobile_phone_number":{"type":"string"}}},"value":{"type":"object","properties":{"currency":{"type":"string"},"amount":{"type":"string"}}},"to":{"type":"object","properties":{"date_of_birth":{"type":"string"},"kyc_document":{"type":"object","properties":{"type":{"type":"string"},"number":{"type":"string"}}},"legal_name":{"type":"string"},"mobile_phone_number":{"type":"string"}}}}}}},"start_date":{"type":"string","format":"date-time"},"id":{"type":"string"}}},"is_featured":false,"special_instructions":"","specified_url":"/obp/v4.0.0/transaction-request-types/CARD/transaction-requests","connector_methods":[]},{"operation_id":"OBPv4.0.0-createTransactionRequestAccountOtp","implemented_by":{"version":"OBPv4.0.0","function":"createTransactionRequestAccountOtp"},"request_verb":"POST","request_url":"/obp/v4.0.0/banks/BANK_ID/accounts/ACCOUNT_ID/VIEW_ID/transaction-request-types/ACCOUNT_OTP/transaction-requests","summary":"Create Transaction Request (ACCOUNT_OTP)","description":"When using ACCOUNT, the payee is set in the request body.
\nMoney goes into the BANK_ID and ACCOUNT_ID specified in the request body.
\nInitiate a Payment via creating a Transaction Request.
\nIn OBP, a transaction request
may or may not result in a transaction
. However, a transaction
only has one possible state: completed.
A Transaction Request
can have one of several states: INITIATED, NEXT_CHALLENGE_PENDING etc.
Transactions
are modeled on items in a bank statement that represent the movement of money.
Transaction Requests
are requests to move money which may or may not succeed and thus result in a Transaction
.
A Transaction Request
might create a security challenge that needs to be answered before the Transaction Request
proceeds.
\nIn case 1 person needs to answer security challenge we have next flow of state of an transaction request
:
\nINITIATED => COMPLETED
\nIn case n persons needs to answer security challenge we have next flow of state of an transaction request
:
\nINITIATED => NEXT_CHALLENGE_PENDING => ... => NEXT_CHALLENGE_PENDING => COMPLETED
The security challenge is bound to a user i.e. in case of right answer and the user is different than expected one the challenge will fail.
\nRule for calculating number of security challenges:
\nIf product Account attribute REQUIRED_CHALLENGE_ANSWERS=N then create N challenges
\n(one for every user that has a View where permission "can_add_transaction_request_to_any_account"=true)
\nIn case REQUIRED_CHALLENGE_ANSWERS is not defined as an account attribute default value is 1.
Transaction Requests contain charge information giving the client the opportunity to proceed or not (as long as the challenge level is appropriate).
\nTransaction Requests can have one of several Transaction Request Types which expect different bodies. The escaped body is returned in the details key of the GET response.
\nThis provides some commonality and one URL for many different payment or transfer types with enough flexibility to validate them differently.
The payer is set in the URL. Money comes out of the BANK_ID and ACCOUNT_ID specified in the URL.
\nIn sandbox mode, TRANSACTION_REQUEST_TYPE is commonly set to ACCOUNT. See getTransactionRequestTypesSupportedByBank for all supported types.
\nIn sandbox mode, if the amount is less than 1000 EUR (any currency, unless it is set differently on this server), the transaction request will create a transaction without a challenge, else the Transaction Request will be set to INITIALISED and a challenge will need to be answered.
\nIf a challenge is created you must answer it using Answer Transaction Request Challenge before the Transaction is created.
\nYou can transfer between different currency accounts. (new in 2.0.0). The currency in body must match the sending account.
\nThe following static FX rates are available in sandbox mode:
\n\nTransaction Requests satisfy PSD2 requirements thus:
\n1) A transaction can be initiated by a third party application.
\n2) The customer is informed of the charge that will incurred.
\n3) The call supports delegated authentication (OAuth)
\nSee this python code for a complete example of this flow.
\nThere is further documentation here
\nAuthentication is Mandatory
\nURL Parameters:
\nACCOUNT_ID: 8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0
\n\nBANK_ID: gh.29.uk
\nVIEW_ID: owner
\nJSON request body fields:
\naccount_id: 8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0
\namount: 10.12
\nbank_id: gh.29.uk
\ncurrency: EUR
\ndescription: This an optional field. Maximum length is 2000. It can be any characters here.
\nto:
\nvalue: 5987953
\nJSON response body fields:
\n\naccount_id: 8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0
\n\namount: 10.12
\nbank_code: CGHZ
\nbank_id: gh.29.uk
\n\n\nchallenges: challenges
\n\ncounterparty_id: 9fg8a7e4-6d02-40e3-a129-0b2bf89de8uh
\n\n\ncurrency: EUR
\ndate_of_birth: 2018-03-09
\n\ndescription: This an optional field. Maximum length is 2000. It can be any characters here.
\n\n\nfrom:
\nfuture_date: 20200127
\niban: DE91 1000 0000 0123 4567 89
\nid: d8839721-ad8f-45dd-9f78-2080414b93f9
\ninstructedAmount: 100
\n\nlegal_name: Eveline Tripman
\nlink:
\nmessage: 123456
\nmobile_phone_number: +49 30 901820
\nname: ACCOUNT_MANAGEMENT_FEE
\n\n\notherAccountRoutingAddress: otherAccountRoutingAddress
\notherAccountRoutingScheme: otherAccountRoutingScheme
\notherAccountSecondaryRoutingAddress: otherAccountSecondaryRoutingAddress
\notherAccountSecondaryRoutingScheme: otherAccountSecondaryRoutingScheme
\notherBankRoutingAddress: otherBankRoutingAddress
\notherBankRoutingScheme: otherBankRoutingScheme
\notherBranchRoutingAddress: otherBranchRoutingAddress
\notherBranchRoutingScheme: otherBranchRoutingScheme
\nstart_date: 2020-01-27
\n\n\nto:
\n\n\ntype:
\nuser_id: 9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1
\nvalue: 5987953
\n\n\n\n\nto_simple: to_simple
\n\n\n\n","description_markdown":"When using ACCOUNT, the payee is set in the request body.\n\nMoney goes into the BANK_ID and ACCOUNT_ID specified in the request body.\n\nInitiate a Payment via creating a Transaction Request.\n\nIn OBP, a `transaction request` may or may not result in a `transaction`. However, a `transaction` only has one possible state: completed.\n\nA `Transaction Request` can have one of several states: INITIATED, NEXT_CHALLENGE_PENDING etc.\n\n`Transactions` are modeled on items in a bank statement that represent the movement of money.\n\n`Transaction Requests` are requests to move money which may or may not succeed and thus result in a `Transaction`.\n\nA `Transaction Request` might create a security challenge that needs to be answered before the `Transaction Request` proceeds.\nIn case 1 person needs to answer security challenge we have next flow of state of an `transaction request`:\n INITIATED => COMPLETED\nIn case n persons needs to answer security challenge we have next flow of state of an `transaction request`:\n INITIATED => NEXT_CHALLENGE_PENDING => ... => NEXT_CHALLENGE_PENDING => COMPLETED\n\nThe security challenge is bound to a user i.e. in case of right answer and the user is different than expected one the challenge will fail.\n\nRule for calculating number of security challenges:\nIf product Account attribute REQUIRED_CHALLENGE_ANSWERS=N then create N challenges\n(one for every user that has a View where permission \"can_add_transaction_request_to_any_account\"=true)\nIn case REQUIRED_CHALLENGE_ANSWERS is not defined as an account attribute default value is 1.\n\nTransaction Requests contain charge information giving the client the opportunity to proceed or not (as long as the challenge level is appropriate).\n\nTransaction Requests can have one of several Transaction Request Types which expect different bodies. The escaped body is returned in the details key of the GET response.\nThis provides some commonality and one URL for many different payment or transfer types with enough flexibility to validate them differently.\n\nThe payer is set in the URL. Money comes out of the BANK_ID and ACCOUNT_ID specified in the URL.\n\nIn sandbox mode, TRANSACTION_REQUEST_TYPE is commonly set to ACCOUNT. See getTransactionRequestTypesSupportedByBank for all supported types.\n\nIn sandbox mode, if the amount is less than 1000 EUR (any currency, unless it is set differently on this server), the transaction request will create a transaction without a challenge, else the Transaction Request will be set to INITIALISED and a challenge will need to be answered.\n\nIf a challenge is created you must answer it using Answer Transaction Request Challenge before the Transaction is created.\n\nYou can transfer between different currency accounts. (new in 2.0.0). The currency in body must match the sending account.\n\nThe following static FX rates are available in sandbox mode:\n\nhttps://apiexplorer-ii-sandbox.openbankproject.com//more?version=OBPv4.0.0&list-all-banks=false&core=&psd2=&obwg=#OBPv2_2_0-getCurrentFxRate\n\n\nTransaction Requests satisfy PSD2 requirements thus:\n\n1) A transaction can be initiated by a third party application.\n\n2) The customer is informed of the charge that will incurred.\n\n3) The call supports delegated authentication (OAuth)\n\nSee [this python code](https://github.com/OpenBankProject/Hello-OBP-DirectLogin-Python/blob/master/hello_payments.py) for a complete example of this flow.\n\nThere is further documentation [here](https://github.com/OpenBankProject/OBP-API/wiki/Transaction-Requests)\n\n\n\n \n\nAuthentication is Mandatory\n\n\n**URL Parameters:**\n\n[ACCOUNT_ID](/glossary#Account.account_id): 8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0\n\n\n\n[ACCOUNT_OTP](/glossary#account_otp): \n\n\n\n[BANK_ID](/glossary#Bank.bank_id): gh.29.uk\n\n\n\n[VIEW_ID](/glossary#this_view_id): owner\n\n\n\n\n\n**JSON request body fields:**\n\n\n\n[**account_id**](/glossary#): 8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0\n\n\n\n[**amount**](/glossary#): 10.12\n\n\n\n[**bank_id**](/glossary#): gh.29.uk\n\n\n\n[**currency**](/glossary#): EUR\n\n\n\n[**description**](/glossary#description): This an optional field. Maximum length is 2000. It can be any characters here.\n\n\n\n[**to**](/glossary#to): \n\n\n\n[**value**](/glossary#): 5987953\n\n\n\n\n\n**JSON response body fields:**\n\n\n\n[**account**](/glossary#Account): \n\n\n\n[**account_id**](/glossary#): 8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0\n\n\n\n[**allowed_attempts**](/glossary#allowed_attempts): 5\n\n\n\n[**amount**](/glossary#): 10.12\n\n\n\n[**bank_code**](/glossary#bank_code): CGHZ\n\n\n\n[**bank_id**](/glossary#): gh.29.uk\n\n\n\n[**branch_number**](/glossary#branch_number): \n\n\n\n[**challenge_type**](/glossary#challenge_type): \n\n\n\n[**challenges**](/glossary#): challenges\n\n\n\n[**charge**](/glossary#charge): \n\n\n\n[**counterparty_id**](/glossary#): 9fg8a7e4-6d02-40e3-a129-0b2bf89de8uh\n\n\n\n[**creditorAccount**](/glossary#creditoraccount): \n\n\n\n[**creditorName**](/glossary#creditorname): \n\n\n\n[**currency**](/glossary#): EUR\n\n\n\n[**date_of_birth**](/glossary#): 2018-03-09\n\n\n\n[**debtorAccount**](/glossary#debtoraccount): \n\n\n\n[**description**](/glossary#description): This an optional field. Maximum length is 2000. It can be any characters here.\n\n\n\n[**details**](/glossary#details): \n\n\n\n[**end_date**](/glossary#end_date): \n\n\n\n[**from**](/glossary#from): \n\n\n\n[**future_date**](/glossary#future_date): 20200127\n\n\n\n[**iban**](/glossary#): DE91 1000 0000 0123 4567 89\n\n\n\n[**id**](/glossary#id): d8839721-ad8f-45dd-9f78-2080414b93f9\n\n\n\n[**instructedAmount**](/glossary#instructedamount): 100\n\n\n\n[**kyc_document**](/glossary#kyc_document): \n\n\n\n[**legal_name**](/glossary#): Eveline Tripman\n\n\n\n[**link**](/glossary#link): \n\n\n\n[**message**](/glossary#message): 123456\n\n\n\n[**mobile_phone_number**](/glossary#mobile_phone_number): +49 30 901820\n\n\n\n[**name**](/glossary#name): ACCOUNT_MANAGEMENT_FEE\n\n\n\n[**nickname**](/glossary#nickname): \n\n\n\n[**number**](/glossary#number): \n\n\n\n[**otherAccountRoutingAddress**](/glossary#): otherAccountRoutingAddress\n\n\n\n[**otherAccountRoutingScheme**](/glossary#): otherAccountRoutingScheme\n\n\n\n[**otherAccountSecondaryRoutingAddress**](/glossary#): otherAccountSecondaryRoutingAddress\n\n\n\n[**otherAccountSecondaryRoutingScheme**](/glossary#): otherAccountSecondaryRoutingScheme\n\n\n\n[**otherBankRoutingAddress**](/glossary#): otherBankRoutingAddress\n\n\n\n[**otherBankRoutingScheme**](/glossary#): otherBankRoutingScheme\n\n\n\n[**otherBranchRoutingAddress**](/glossary#): otherBranchRoutingAddress\n\n\n\n[**otherBranchRoutingScheme**](/glossary#): otherBranchRoutingScheme\n\n\n\n[**start_date**](/glossary#): 2020-01-27\n\n\n\n[**status**](/glossary#status): \n\n\n\n[**summary**](/glossary#summary): \n\n\n\n[**to**](/glossary#to): \n\n\n\n[**transaction_ids**](/glossary#transaction_ids): \n\n\n\n[**transfer_type**](/glossary#transfer_type): \n\n\n\n[**type**](/glossary#type): \n\n\n\n[**user_id**](/glossary#): 9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1\n\n\n\n[**value**](/glossary#): 5987953\n\n\n\n[to_counterparty](/glossary#to_counterparty): \n\n\n\n[to_sandbox_tan](/glossary#to_sandbox_tan): \n\n\n\n[to_sepa](/glossary#to_sepa): \n\n\n\n[to_sepa_credit_transfers](/glossary#to_sepa_credit_transfers): \n\n\n\n[to_simple](/glossary#): to_simple\n\n\n\n[to_transfer_to_account](/glossary#to_transfer_to_account): \n\n\n\n[to_transfer_to_atm](/glossary#to_transfer_to_atm): \n\n\n\n[to_transfer_to_phone](/glossary#to_transfer_to_phone): \n\n\n","example_request_body":{"to":{"bank_id":"gh.29.uk","account_id":"8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0"},"value":{"currency":"EUR","amount":"0"},"description":"this is for work"},"success_response_body":{"id":"4050046c-63b3-4868-8a22-14b4181d33a6","type":"SANDBOX_TAN","from":{"bank_id":"gh.29.uk","account_id":"8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0"},"details":{"to_sandbox_tan":{"bank_id":"String","account_id":"String"},"to_sepa":{"iban":"String"},"to_counterparty":{"counterparty_id":"9fg8a7e4-6d02-40e3-a129-0b2bf89de8uh"},"to_simple":{"otherBankRoutingScheme":"BIC","otherBankRoutingAddress":"GENODEM1GLS","otherBranchRoutingScheme":"BRANCH-CODE","otherBranchRoutingAddress":"DERBY6","otherAccountRoutingScheme":"IBAN","otherAccountRoutingAddress":"DE91 1000 0000 0123 4567 89","otherAccountSecondaryRoutingScheme":"IBAN","otherAccountSecondaryRoutingAddress":"DE91 1000 0000 0123 4567 89"},"to_transfer_to_phone":{"value":{"currency":"EUR","amount":"0"},"description":"String","message":"String","from":{"mobile_phone_number":"+44 07972 444 876","nickname":"String"},"to":{"mobile_phone_number":"+44 07972 444 876"}},"to_transfer_to_atm":{"value":{"currency":"EUR","amount":"0"},"description":"String","message":"String","from":{"mobile_phone_number":"+44 07972 444 876","nickname":"String"},"to":{"legal_name":"Eveline Tripman","date_of_birth":"20181230","mobile_phone_number":"+44 07972 444 876","kyc_document":{"type":"String","number":"String"}}},"to_transfer_to_account":{"value":{"currency":"EUR","amount":"0"},"description":"String","transfer_type":"String","future_date":"20181230","to":{"name":"String","bank_code":"String","branch_number":"String","account":{"number":"String","iban":"String"}}},"to_sepa_credit_transfers":{"debtorAccount":{"iban":"12345"},"instructedAmount":{"currency":"EUR","amount":"0"},"creditorAccount":{"iban":"54321"},"creditorName":"John Miles"},"value":{"currency":"EUR","amount":"100"},"description":"This an optional field. Maximum length is 2000. It can be any characters here."},"transaction_ids":["902ba3bb-dedd-45e7-9319-2fd3f2cd98a1"],"status":"COMPLETED","start_date":"1100-01-01T00:00:00Z","end_date":"1100-01-01T00:00:00Z","challenges":[{"id":"2fg8a7e4-6d02-40e3-a129-0b2bf89de8ub","user_id":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1","allowed_attempts":3,"challenge_type":"OBP_TRANSACTION_REQUEST_CHALLENGE","link":"/obp/v4.0.0/banks/BANK_ID/accounts/ACCOUNT_ID/VIEW_ID/transaction-request-types/TRANSACTION_REQUEST_TYPE/transaction-requests/TRANSACTION_REQUEST_ID/challenge"}],"charge":{"summary":"Rent the flat","value":{"currency":"EUR","amount":"0"}}},"error_response_bodies":["OBP-20001: User not logged in. Authentication is required!","OBP-30111: Invalid Bank Id. The BANK_ID should only contain 0-9/a-z/A-Z/'-'/'.'/'_', the length should be smaller than 255.","OBP-30110: Invalid Account Id. The ACCOUNT_ID should only contain 0-9/a-z/A-Z/'-'/'.'/'_', the length should be smaller than 255.","OBP-10001: Incorrect json format.","OBP-30001: Bank not found. Please specify a valid value for BANK_ID.","OBP-30003: Account not found. Please specify a valid value for ACCOUNT_ID.","OBP-30018: Bank Account not found. Please specify valid values for BANK_ID and ACCOUNT_ID. ","OBP-40002: Insufficient authorisation to create TransactionRequest. The Transaction Request could not be created because the login user doesn't have access to the view of the from account or the consumer doesn't have the access to the view of the from account or the login user does not have the `CanCreateAnyTransactionRequest` role or the view does not have the permission canaddtransactionrequesttoanyaccount.","OBP-40001: Invalid value for TRANSACTION_REQUEST_TYPE","OBP-10001: Incorrect json format.","OBP-10002: Invalid Number. Could not convert value to a number.","OBP-40008: Can't send a payment with a value of 0 or less.","OBP-40003: Transaction Request Currency must be the same as From Account Currency.","OBP-00003: Transaction Requests is disabled in this API instance.","OBP-50000: Unknown Error."],"tags":["Transaction-Request","Payment Initiation Service (PIS)","PSD2"],"typed_request_body":{"type":"object","properties":{"to":{"type":"object","properties":{"bank_id":{"type":"string"},"account_id":{"type":"string"}}},"description":{"type":"string"},"value":{"type":"object","properties":{"currency":{"type":"string"},"amount":{"type":"string"}}}}},"typed_success_response_body":{"type":"object","properties":{"type":{"type":"string"},"challenges":{"type":"array","items":{"type":"object","properties":{"challenge_type":{"type":"string"},"link":{"type":"string"},"id":{"type":"string"},"allowed_attempts":{"type":"integer"},"user_id":{"type":"string"}}}},"status":{"type":"string"},"end_date":{"type":"string","format":"date-time"},"charge":{"type":"object","properties":{"summary":{"type":"string"},"value":{"type":"object","properties":{"currency":{"type":"string"},"amount":{"type":"string"}}}}},"transaction_ids":{"type":"array","items":{"type":"string"}},"from":{"type":"object","properties":{"bank_id":{"type":"string"},"account_id":{"type":"string"}}},"details":{"type":"object","properties":{"description":{"type":"string"},"to_sandbox_tan":{"type":"object","properties":{"account_id":{"type":"string"},"bank_id":{"type":"string"}}},"value":{"type":"object","properties":{"currency":{"type":"string"},"amount":{"type":"string"}}},"to_transfer_to_phone":{"type":"object","properties":{"description":{"type":"string"},"message":{"type":"string"},"from":{"type":"object","properties":{"nickname":{"type":"string"},"mobile_phone_number":{"type":"string"}}},"to":{"type":"object","properties":{"mobile_phone_number":{"type":"string"}}},"value":{"type":"object","properties":{"currency":{"type":"string"},"amount":{"type":"string"}}}}},"to_sepa":{"type":"object","properties":{"iban":{"type":"string"}}},"to_simple":{"type":"object","properties":{"otherBankRoutingAddress":{"type":"string"},"otherAccountSecondaryRoutingAddress":{"type":"string"},"otherBranchRoutingScheme":{"type":"string"},"otherAccountRoutingScheme":{"type":"string"},"otherAccountRoutingAddress":{"type":"string"},"otherBankRoutingScheme":{"type":"string"},"otherBranchRoutingAddress":{"type":"string"},"otherAccountSecondaryRoutingScheme":{"type":"string"}}},"to_counterparty":{"type":"object","properties":{"counterparty_id":{"type":"string"}}},"to_transfer_to_account":{"type":"object","properties":{"to":{"type":"object","properties":{"name":{"type":"string"},"account":{"type":"object","properties":{"number":{"type":"string"},"iban":{"type":"string"}}},"bank_code":{"type":"string"},"branch_number":{"type":"string"}}},"transfer_type":{"type":"string"},"description":{"type":"string"},"future_date":{"type":"string"},"value":{"type":"object","properties":{"currency":{"type":"string"},"amount":{"type":"string"}}}}},"to_sepa_credit_transfers":{"type":"object","properties":{"instructedAmount":{"type":"object","properties":{"currency":{"type":"string"},"amount":{"type":"string"}}},"debtorAccount":{"type":"object","properties":{"iban":{"type":"string"}}},"creditorAccount":{"type":"object","properties":{"iban":{"type":"string"}}},"creditorName":{"type":"string"}}},"to_transfer_to_atm":{"type":"object","properties":{"description":{"type":"string"},"message":{"type":"string"},"from":{"type":"object","properties":{"nickname":{"type":"string"},"mobile_phone_number":{"type":"string"}}},"value":{"type":"object","properties":{"currency":{"type":"string"},"amount":{"type":"string"}}},"to":{"type":"object","properties":{"date_of_birth":{"type":"string"},"kyc_document":{"type":"object","properties":{"type":{"type":"string"},"number":{"type":"string"}}},"legal_name":{"type":"string"},"mobile_phone_number":{"type":"string"}}}}}}},"start_date":{"type":"string","format":"date-time"},"id":{"type":"string"}}},"is_featured":false,"special_instructions":"","specified_url":"/obp/v4.0.0/banks/BANK_ID/accounts/ACCOUNT_ID/VIEW_ID/transaction-request-types/ACCOUNT_OTP/transaction-requests","connector_methods":[]},{"operation_id":"OBPv4.0.0-getTransactionRequestAttributeById","implemented_by":{"version":"OBPv4.0.0","function":"getTransactionRequestAttributeById"},"request_verb":"GET","request_url":"/obp/v4.0.0/banks/BANK_ID/accounts/ACCOUNT_ID/transaction-requests/TRANSACTION_REQUEST_ID/attributes/ATTRIBUTE_ID","summary":"Get Transaction Request Attribute By Id","description":"Get Transaction Request Attribute By Id
\nAuthentication is Mandatory
\nURL Parameters:
\nACCOUNT_ID: 8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0
\n\nBANK_ID: gh.29.uk
\nTRANSACTION_REQUEST_ID: 8138a7e4-6d02-40e3-a129-0b2bf89de9f1
\nJSON response body fields:
\nname: ACCOUNT_MANAGEMENT_FEE
\ntransaction_request_attribute_id: 7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh
\ntype:
\nvalue: 5987953
\n","description_markdown":"Get Transaction Request Attribute By Id\n\nAuthentication is Mandatory\n\n\n**URL Parameters:**\n\n[ACCOUNT_ID](/glossary#Account.account_id): 8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0\n\n\n\n[ATTRIBUTE_ID](/glossary#Adapter.card_attribute_id): \n\n\n\n[BANK_ID](/glossary#Bank.bank_id): gh.29.uk\n\n\n\n[TRANSACTION_REQUEST_ID](/glossary#): 8138a7e4-6d02-40e3-a129-0b2bf89de9f1\n\n\n\n\n\n**JSON response body fields:**\n\n\n\n[**name**](/glossary#name): ACCOUNT_MANAGEMENT_FEE\n\n\n\n[**transaction_request_attribute_id**](/glossary#): 7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh\n\n\n\n[**type**](/glossary#type): \n\n\n\n[**value**](/glossary#): 5987953\n\n\n","success_response_body":{"transaction_request_attribute_id":"7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh","name":"HOUSE_RENT","type":"DATE_WITH_DAY","value":"123456789"},"error_response_bodies":["OBP-20001: User not logged in. Authentication is required!","OBP-30001: Bank not found. Please specify a valid value for BANK_ID.","OBP-30018: Bank Account not found. Please specify valid values for BANK_ID and ACCOUNT_ID. ","OBP-10001: Incorrect json format.","OBP-50000: Unknown Error.","OBP-20006: User is missing one or more roles: "],"tags":["Transaction-Request"],"typed_success_response_body":{"type":"object","properties":{"name":{"type":"string"},"type":{"type":"string"},"transaction_request_attribute_id":{"type":"string"},"value":{"type":"string"}}},"roles":[{"role":"CanGetTransactionRequestAttributeAtOneBank","requires_bank_id":true}],"is_featured":false,"special_instructions":"","specified_url":"/obp/v4.0.0/banks/BANK_ID/accounts/ACCOUNT_ID/transaction-requests/TRANSACTION_REQUEST_ID/attributes/ATTRIBUTE_ID","connector_methods":[]},{"operation_id":"OBPv4.0.0-updateTransactionRequestAttribute","implemented_by":{"version":"OBPv4.0.0","function":"updateTransactionRequestAttribute"},"request_verb":"PUT","request_url":"/obp/v4.0.0/banks/BANK_ID/accounts/ACCOUNT_ID/transaction-requests/TRANSACTION_REQUEST_ID/attributes/ATTRIBUTE_ID","summary":"Update Transaction Request Attribute","description":"Update Transaction Request Attribute
\nAuthentication is Mandatory
\nURL Parameters:
\nACCOUNT_ID: 8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0
\n\nBANK_ID: gh.29.uk
\nTRANSACTION_REQUEST_ID: 8138a7e4-6d02-40e3-a129-0b2bf89de9f1
\nJSON response body fields:
\nname: ACCOUNT_MANAGEMENT_FEE
\ntransaction_request_attribute_id: 7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh
\ntype:
\nvalue: 5987953
\n","description_markdown":"Update Transaction Request Attribute\n\nAuthentication is Mandatory\n\n\n**URL Parameters:**\n\n[ACCOUNT_ID](/glossary#Account.account_id): 8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0\n\n\n\n[ATTRIBUTE_ID](/glossary#Adapter.card_attribute_id): \n\n\n\n[BANK_ID](/glossary#Bank.bank_id): gh.29.uk\n\n\n\n[TRANSACTION_REQUEST_ID](/glossary#): 8138a7e4-6d02-40e3-a129-0b2bf89de9f1\n\n\n\n\n\n**JSON response body fields:**\n\n\n\n[**name**](/glossary#name): ACCOUNT_MANAGEMENT_FEE\n\n\n\n[**transaction_request_attribute_id**](/glossary#): 7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh\n\n\n\n[**type**](/glossary#type): \n\n\n\n[**value**](/glossary#): 5987953\n\n\n","example_request_body":{"name":"HOUSE_RENT","type":"DATE_WITH_DAY","value":"123456789"},"success_response_body":{"transaction_request_attribute_id":"7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh","name":"HOUSE_RENT","type":"DATE_WITH_DAY","value":"123456789"},"error_response_bodies":["OBP-20001: User not logged in. Authentication is required!","OBP-30001: Bank not found. Please specify a valid value for BANK_ID.","OBP-30018: Bank Account not found. Please specify valid values for BANK_ID and ACCOUNT_ID. ","OBP-10001: Incorrect json format.","OBP-50000: Unknown Error.","OBP-20006: User is missing one or more roles: "],"tags":["Transaction-Request"],"typed_request_body":{"type":"object","properties":{"name":{"type":"string"},"type":{"type":"string"},"value":{"type":"string"}}},"typed_success_response_body":{"type":"object","properties":{"name":{"type":"string"},"type":{"type":"string"},"transaction_request_attribute_id":{"type":"string"},"value":{"type":"string"}}},"roles":[{"role":"CanUpdateTransactionRequestAttributeAtOneBank","requires_bank_id":true}],"is_featured":false,"special_instructions":"","specified_url":"/obp/v4.0.0/banks/BANK_ID/accounts/ACCOUNT_ID/transaction-requests/TRANSACTION_REQUEST_ID/attributes/ATTRIBUTE_ID","connector_methods":[]},{"operation_id":"OBPv4.0.0-createHistoricalTransactionAtBank","implemented_by":{"version":"OBPv4.0.0","function":"createHistoricalTransactionAtBank"},"request_verb":"POST","request_url":"/obp/v4.0.0/banks/BANK_ID/management/historical/transactions","summary":"Create Historical Transactions ","description":"Create historical transactions at one Bank
\nUse this endpoint to create transactions between any two accounts at the same bank.
\nFrom account and to account must be at the same bank.
\nExample:
\n{
\n"from_account_id": "1ca8a7e4-6d02-48e3-a029-0b2bf89de9f0",
\n"to_account_id": "2ca8a7e4-6d02-48e3-a029-0b2bf89de9f0",
\n"value": {
\n"currency": "GBP",
\n"amount": "10"
\n},
\n"description": "this is for work",
\n"posted": "2017-09-19T02:31:05Z",
\n"completed": "2017-09-19T02:31:05Z",
\n"type": "SANDBOX_TAN",
\n"charge_policy": "SHARED"
\n}
This call is experimental.
\nAuthentication is Mandatory
\nURL Parameters:
\nBANK_ID: gh.29.uk
\nJSON request body fields:
\namount: 10.12
\ncharge_policy: SHARED
\ncompleted: 2020-01-27
\ncurrency: EUR
\ndescription: This an optional field. Maximum length is 2000. It can be any characters here.
\nfrom_account_id: from_account_id
\nposted: 2020-01-27
\nto_account_id: to_account_id
\ntype:
\nvalue: 5987953
\nJSON response body fields:
\namount: 10.12
\ncharge_policy: SHARED
\ncompleted: 2020-01-27
\ncurrency: EUR
\ndescription: This an optional field. Maximum length is 2000. It can be any characters here.
\nfrom:
\nposted: 2020-01-27
\nto:
\ntransaction_id: 2fg8a7e4-6d02-40e3-a129-0b2bf89de8ub
\ntransaction_request_type: SEPA
\nvalue: 5987953
\naccount_id: 8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0
\nbank_id: gh.29.uk
\ncounterparty_id: 9fg8a7e4-6d02-40e3-a129-0b2bf89de8uh
\n","description_markdown":"Create historical transactions at one Bank\n\nUse this endpoint to create transactions between any two accounts at the same bank. \nFrom account and to account must be at the same bank.\nExample:\n{\n \"from_account_id\": \"1ca8a7e4-6d02-48e3-a029-0b2bf89de9f0\",\n \"to_account_id\": \"2ca8a7e4-6d02-48e3-a029-0b2bf89de9f0\",\n \"value\": {\n \"currency\": \"GBP\",\n \"amount\": \"10\"\n },\n \"description\": \"this is for work\",\n \"posted\": \"2017-09-19T02:31:05Z\",\n \"completed\": \"2017-09-19T02:31:05Z\",\n \"type\": \"SANDBOX_TAN\",\n \"charge_policy\": \"SHARED\"\n}\n\nThis call is experimental.\n \n\nAuthentication is Mandatory\n\n\n**URL Parameters:**\n\n[BANK_ID](/glossary#Bank.bank_id): gh.29.uk\n\n\n\n\n\n**JSON request body fields:**\n\n\n\n[**amount**](/glossary#): 10.12\n\n\n\n[**charge_policy**](/glossary#): SHARED\n\n\n\n[**completed**](/glossary#completed): 2020-01-27\n\n\n\n[**currency**](/glossary#): EUR\n\n\n\n[**description**](/glossary#description): This an optional field. Maximum length is 2000. It can be any characters here.\n\n\n\n[**from_account_id**](/glossary#): from_account_id\n\n\n\n[**posted**](/glossary#posted): 2020-01-27\n\n\n\n[**to_account_id**](/glossary#): to_account_id\n\n\n\n[**type**](/glossary#type): \n\n\n\n[**value**](/glossary#): 5987953\n\n\n\n\n\n**JSON response body fields:**\n\n\n\n[**amount**](/glossary#): 10.12\n\n\n\n[**charge_policy**](/glossary#): SHARED\n\n\n\n[**completed**](/glossary#completed): 2020-01-27\n\n\n\n[**currency**](/glossary#): EUR\n\n\n\n[**description**](/glossary#description): This an optional field. Maximum length is 2000. It can be any characters here.\n\n\n\n[**from**](/glossary#from): \n\n\n\n[**posted**](/glossary#posted): 2020-01-27\n\n\n\n[**to**](/glossary#to): \n\n\n\n[**transaction_id**](/glossary#): 2fg8a7e4-6d02-40e3-a129-0b2bf89de8ub\n\n\n\n[**transaction_request_type**](/glossary#): SEPA\n\n\n\n[**value**](/glossary#): 5987953\n\n\n\n[account_id](/glossary#): 8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0\n\n\n\n[bank_id](/glossary#): gh.29.uk\n\n\n\n[counterparty_id](/glossary#): 9fg8a7e4-6d02-40e3-a129-0b2bf89de8uh\n\n\n","example_request_body":{"from_account_id":"","to_account_id":"","value":{"currency":"EUR","amount":"0"},"description":"this is for work","posted":"1100-01-01T01:01:01Z","completed":"1100-01-01T01:01:01Z","type":"SANDBOX_TAN","charge_policy":"SHARED"},"success_response_body":{"transaction_id":"2fg8a7e4-6d02-40e3-a129-0b2bf89de8ub","from":{"bank_id":"gh.29.uk","account_id":"8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0","counterparty_id":"9fg8a7e4-6d02-40e3-a129-0b2bf89de8uh"},"to":{"bank_id":"gh.29.uk","account_id":"8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0","counterparty_id":"9fg8a7e4-6d02-40e3-a129-0b2bf89de8uh"},"value":{"currency":"EUR","amount":"0"},"description":"this is for work","posted":"1100-01-01T01:01:01Z","completed":"1100-01-01T01:01:01Z","transaction_request_type":"SANDBOX_TAN","charge_policy":"SHARED"},"error_response_bodies":["OBP-10001: Incorrect json format.","OBP-30001: Bank not found. Please specify a valid value for BANK_ID.","OBP-30003: Account not found. Please specify a valid value for ACCOUNT_ID.","OBP-30017: Counterparty not found. Please specify a valid value for COUNTERPARTY_ID.","OBP-10002: Invalid Number. Could not convert value to a number.","OBP-40008: Can't send a payment with a value of 0 or less.","OBP-40003: Transaction Request Currency must be the same as From Account Currency.","OBP-50000: Unknown Error.","OBP-20001: User not logged in. Authentication is required!","OBP-20006: User is missing one or more roles: "],"tags":["Transaction-Request"],"typed_request_body":{"type":"object","properties":{"type":{"type":"string"},"from_account_id":{"type":"string"},"completed":{"type":"string"},"description":{"type":"string"},"value":{"type":"object","properties":{"currency":{"type":"string"},"amount":{"type":"string"}}},"charge_policy":{"type":"string"},"posted":{"type":"string"},"to_account_id":{"type":"string"}}},"typed_success_response_body":{"type":"object","properties":{"description":{"type":"string"},"completed":{"type":"string","format":"date-time"},"from":{"type":"object","properties":{"bank_id":{"type":"string"},"account_id":{"type":"string"},"counterparty_id":{"type":"string"}}},"transaction_request_type":{"type":"string"},"to":{"type":"object","properties":{"bank_id":{"type":"string"},"account_id":{"type":"string"},"counterparty_id":{"type":"string"}}},"value":{"type":"object","properties":{"currency":{"type":"string"},"amount":{"type":"string"}}},"charge_policy":{"type":"string"},"transaction_id":{"type":"string"},"posted":{"type":"string","format":"date-time"}}},"roles":[{"role":"CanCreateHistoricalTransactionAtBank","requires_bank_id":true}],"is_featured":false,"special_instructions":"","specified_url":"/obp/v4.0.0/banks/BANK_ID/management/historical/transactions","connector_methods":[]},{"operation_id":"OBPv2.1.0-createTransactionRequestSandboxTan","implemented_by":{"version":"OBPv2.1.0","function":"createTransactionRequestSandboxTan"},"request_verb":"POST","request_url":"/obp/v2.1.0/banks/BANK_ID/accounts/ACCOUNT_ID/VIEW_ID/transaction-request-types/SANDBOX_TAN/transaction-requests","summary":"Create Transaction Request (SANDBOX_TAN)","description":"When using SANDBOX_TAN, the payee is set in the request body.
\nMoney goes into the BANK_ID and ACCOUNT_ID specified in the request body.
\nInitiate a Payment via creating a Transaction Request.
\nIn OBP, a transaction request
may or may not result in a transaction
. However, a transaction
only has one possible state: completed.
A Transaction Request
can have one of several states.
Transactions
are modeled on items in a bank statement that represent the movement of money.
Transaction Requests
are requests to move money which may or may not succeeed and thus result in a Transaction
.
A Transaction Request
might create a security challenge that needs to be answered before the Transaction Request
proceeds.
Transaction Requests contain charge information giving the client the opportunity to proceed or not (as long as the challenge level is appropriate).
\nTransaction Requests can have one of several Transaction Request Types which expect different bodies. The escaped body is returned in the details key of the GET response.
\nThis provides some commonality and one URL for many different payment or transfer types with enough flexibility to validate them differently.
The payer is set in the URL. Money comes out of the BANK_ID and ACCOUNT_ID specified in the URL.
\nIn sandbox mode, TRANSACTION_REQUEST_TYPE is commonly set to SANDBOX_TAN. See getTransactionRequestTypesSupportedByBank for all supported types.
\nIn sandbox mode, if the amount is less than 1000 EUR (any currency, unless it is set differently on this server), the transaction request will create a transaction without a challenge, else the Transaction Request will be set to INITIALISED and a challenge will need to be answered.
\nIf a challenge is created you must answer it using Answer Transaction Request Challenge before the Transaction is created.
\nYou can transfer between different currency accounts. (new in 2.0.0). The currency in body must match the sending account.
\nThe following static FX rates are available in sandbox mode:
\n{
\n"XAF":{
\n"XAF":1.0,
\n"HKD":0.0135503,
\n"AUD":0.00228226,
\n"KRW":1.87975,
\n"JOD":0.00127784,
\n"GBP":0.00131092,
\n"MXN":0.0396,
\n"AED":0.00601555,
\n"INR":0.110241,
\n"XBT":2.9074795E-8,
\n"JPY":0.185328,
\n"USD":0.00163773,
\n"ILS":0.00641333,
\n"EUR":0.00152449
\n},
\n"HKD":{
\n"XAF":73.8049,
\n"HKD":1.0,
\n"AUD":0.178137,
\n"KRW":143.424,
\n"JOD":0.0903452,
\n"GBP":0.0985443,
\n"MXN":2.8067,
\n"AED":0.467977,
\n"INR":9.09325,
\n"XBT":2.164242461E-6,
\n"JPY":14.0867,
\n"USD":0.127427,
\n"ILS":0.460862,
\n"EUR":0.112495
\n},
\n"AUD":{
\n"XAF":438.162,
\n"HKD":5.61346,
\n"AUD":1.0,
\n"KRW":895.304,
\n"JOD":0.556152,
\n"GBP":0.609788,
\n"MXN":16.0826,
\n"AED":2.88368,
\n"INR":50.4238,
\n"XBT":1.2284055924E-5,
\n"JPY":87.0936,
\n"USD":0.785256,
\n"ILS":2.83558,
\n"EUR":0.667969
\n},
\n"KRW":{
\n"XAF":0.531986,
\n"HKD":0.00697233,
\n"AUD":0.00111694,
\n"KRW":1.0,
\n"JOD":6.30634E-4,
\n"GBP":6.97389E-4,
\n"MXN":0.0183,
\n"AED":0.00320019,
\n"INR":0.0586469,
\n"XBT":1.4234725E-8,
\n"JPY":0.0985917,
\n"USD":8.7125E-4,
\n"ILS":0.00316552,
\n"EUR":8.11008E-4
\n},
\n"JOD":{
\n"XAF":782.572,
\n"HKD":11.0687,
\n"AUD":1.63992,
\n"KRW":1585.68,
\n"JOD":1.0,
\n"GBP":1.06757,
\n"MXN":30.8336,
\n"AED":5.18231,
\n"INR":90.1236,
\n"XBT":2.3803244006E-5,
\n"JPY":156.304,
\n"USD":1.41112,
\n"ILS":5.02018,
\n"EUR":0.237707
\n},
\n"GBP":{
\n"XAF":762.826,
\n"HKD":10.1468,
\n"AUD":1.63992,
\n"KRW":1433.92,
\n"JOD":0.936707,
\n"GBP":1.0,
\n"MXN":29.242,
\n"AED":4.58882,
\n"INR":84.095,
\n"XBT":2.2756409956E-5,
\n"JPY":141.373,
\n"USD":1.2493,
\n"ILS":4.7002,
\n"EUR":1.16278
\n},
\n"MXN":{
\n"XAF":25.189,
\n"HKD":0.3562,
\n"AUD":0.0621,
\n"KRW":54.4512,
\n"JOD":0.0324,
\n"GBP":0.0341,
\n"MXN":1.0,
\n"AED":0.1688,
\n"INR":3.3513,
\n"XBT":8.1112586E-7,
\n"JPY":4.8687,
\n"USD":0.0459,
\n"ILS":0.1541,
\n"EUR":0.0384
\n},
\n"AED":{
\n"XAF":166.236,
\n"HKD":2.13685,
\n"AUD":0.346779,
\n"KRW":312.482,
\n"JOD":0.1930565,
\n"GBP":0.217921,
\n"MXN":5.9217,
\n"AED":1.0,
\n"INR":18.3255,
\n"XBT":4.603349217E-6,
\n"JPY":30.8081,
\n"USD":0.27225,
\n"ILS":0.968033,
\n"EUR":0.253425
\n},
\n"INR":{
\n"XAF":9.07101,
\n"HKD":0.109972,
\n"AUD":0.0198319,
\n"KRW":17.0512,
\n"JOD":0.0110959,
\n"GBP":0.0118913,
\n"MXN":0.2983,
\n"AED":0.0545671,
\n"INR":1.0,
\n"XBT":2.2689396E-7,
\n"JPY":1.68111,
\n"USD":0.0148559,
\n"ILS":0.0556764,
\n"EUR":0.0138287
\n},
\n"XBT":{
\n"XAF":3.4353824E7,
\n"HKD":460448.9,
\n"AUD":81168.603,
\n"KRW":7.0131575E7,
\n"JOD":41960.111,
\n"GBP":44188.118,
\n"MXN":1230503.3,
\n"AED":217414.47,
\n"INR":4407607.74,
\n"XBT":1.0,
\n"JPY":6805170.8,
\n"USD":59245.918,
\n"ILS":182981.21,
\n"EUR":52436.431
\n},
\n"JPY":{
\n"XAF":5.39585,
\n"HKD":0.0709891,
\n"AUD":0.0114819,
\n"KRW":10.1428,
\n"JOD":0.00639777,
\n"GBP":0.0070735,
\n"MXN":0.2053,
\n"AED":0.032459,
\n"INR":0.594846,
\n"XBT":1.47171931E-7,
\n"JPY":1.0,
\n"USD":0.00883695,
\n"ILS":0.0320926,
\n"EUR":0.00822592
\n},
\n"USD":{
\n"XAF":610.601,
\n"HKD":7.84766,
\n"AUD":1.27347,
\n"KRW":1147.78,
\n"JOD":0.708659,
\n"GBP":0.800446,
\n"MXN":21.748,
\n"AED":3.6731,
\n"INR":67.3135,
\n"XBT":1.69154E-5,
\n"JPY":113.161,
\n"USD":1.0,
\n"ILS":3.55495,
\n"EUR":0.930886
\n},
\n"ILS":{
\n"XAF":155.925,
\n"HKD":2.16985,
\n"AUD":0.352661,
\n"KRW":315.903,
\n"JOD":0.199196,
\n"GBP":0.212763,
\n"MXN":6.4871,
\n"AED":1.03302,
\n"INR":17.9609,
\n"XBT":5.452272147E-6,
\n"JPY":31.1599,
\n"USD":0.281298,
\n"ILS":1.0,
\n"EUR":1.19318
\n},
\n"EUR":{
\n"XAF":655.957,
\n"HKD":8.88926,
\n"AUD":1.49707,
\n"KRW":1233.03,
\n"JOD":0.838098,
\n"GBP":0.860011,
\n"MXN":26.0359,
\n"AED":3.94594,
\n"INR":72.3136,
\n"XBT":1.9087905636E-5,
\n"JPY":121.567,
\n"USD":1.07428,
\n"ILS":4.20494,
\n"EUR":1.0
\n}
\n}
Transaction Requests satisfy PSD2 requirements thus:
\n1) A transaction can be initiated by a third party application.
\n2) The customer is informed of the charge that will incurred.
\n3) The call supports delegated authentication (OAuth)
\nSee this python code for a complete example of this flow.
\nThere is further documentation here
\nAuthentication is Mandatory
\nURL Parameters:
\nACCOUNT_ID: 8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0
\nBANK_ID: gh.29.uk
\n\nVIEW_ID: owner
\nJSON request body fields:
\naccount_id: 8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0
\namount: 10.12
\nbank_id: gh.29.uk
\ncurrency: EUR
\ndescription: This an optional field. Maximum length is 2000. It can be any characters here.
\nto:
\nvalue: 5987953
\nJSON response body fields:
\n\naccount_id: 8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0
\n\namount: 10.12
\nbank_code: CGHZ
\nbank_id: gh.29.uk
\n\n\n\n\ncounterparty_id: 9fg8a7e4-6d02-40e3-a129-0b2bf89de8uh
\n\n\ncurrency: EUR
\ndate_of_birth: 2018-03-09
\n\ndescription: This an optional field. Maximum length is 2000. It can be any characters here.
\n\n\nfrom:
\nfuture_date: 20200127
\niban: DE91 1000 0000 0123 4567 89
\nid: d8839721-ad8f-45dd-9f78-2080414b93f9
\ninstructedAmount: 100
\n\nlegal_name: Eveline Tripman
\nmessage: 123456
\nmobile_phone_number: +49 30 901820
\nname: ACCOUNT_MANAGEMENT_FEE
\n\n\notherAccountRoutingAddress: otherAccountRoutingAddress
\notherAccountRoutingScheme: otherAccountRoutingScheme
\notherAccountSecondaryRoutingAddress: otherAccountSecondaryRoutingAddress
\notherAccountSecondaryRoutingScheme: otherAccountSecondaryRoutingScheme
\notherBankRoutingAddress: otherBankRoutingAddress
\notherBankRoutingScheme: otherBankRoutingScheme
\notherBranchRoutingAddress: otherBranchRoutingAddress
\notherBranchRoutingScheme: otherBranchRoutingScheme
\nstart_date: 2020-01-27
\n\n\nto:
\n\n\ntype:
\nvalue: 5987953
\n\n\n\n\nto_simple: to_simple
\n\n\n\n","description_markdown":"When using SANDBOX_TAN, the payee is set in the request body.\n\nMoney goes into the BANK_ID and ACCOUNT_ID specified in the request body.\n\nInitiate a Payment via creating a Transaction Request.\n\nIn OBP, a `transaction request` may or may not result in a `transaction`. However, a `transaction` only has one possible state: completed.\n\nA `Transaction Request` can have one of several states.\n\n`Transactions` are modeled on items in a bank statement that represent the movement of money.\n\n`Transaction Requests` are requests to move money which may or may not succeeed and thus result in a `Transaction`.\n\nA `Transaction Request` might create a security challenge that needs to be answered before the `Transaction Request` proceeds.\n\nTransaction Requests contain charge information giving the client the opportunity to proceed or not (as long as the challenge level is appropriate).\n\nTransaction Requests can have one of several Transaction Request Types which expect different bodies. The escaped body is returned in the details key of the GET response.\nThis provides some commonality and one URL for many different payment or transfer types with enough flexibility to validate them differently.\n\nThe payer is set in the URL. Money comes out of the BANK_ID and ACCOUNT_ID specified in the URL.\n\nIn sandbox mode, TRANSACTION_REQUEST_TYPE is commonly set to SANDBOX_TAN. See getTransactionRequestTypesSupportedByBank for all supported types.\n\nIn sandbox mode, if the amount is less than 1000 EUR (any currency, unless it is set differently on this server), the transaction request will create a transaction without a challenge, else the Transaction Request will be set to INITIALISED and a challenge will need to be answered.\n\nIf a challenge is created you must answer it using Answer Transaction Request Challenge before the Transaction is created.\n\nYou can transfer between different currency accounts. (new in 2.0.0). The currency in body must match the sending account.\n\nThe following static FX rates are available in sandbox mode:\n\n{\n \"XAF\":{\n \"XAF\":1.0,\n \"HKD\":0.0135503,\n \"AUD\":0.00228226,\n \"KRW\":1.87975,\n \"JOD\":0.00127784,\n \"GBP\":0.00131092,\n \"MXN\":0.0396,\n \"AED\":0.00601555,\n \"INR\":0.110241,\n \"XBT\":2.9074795E-8,\n \"JPY\":0.185328,\n \"USD\":0.00163773,\n \"ILS\":0.00641333,\n \"EUR\":0.00152449\n },\n \"HKD\":{\n \"XAF\":73.8049,\n \"HKD\":1.0,\n \"AUD\":0.178137,\n \"KRW\":143.424,\n \"JOD\":0.0903452,\n \"GBP\":0.0985443,\n \"MXN\":2.8067,\n \"AED\":0.467977,\n \"INR\":9.09325,\n \"XBT\":2.164242461E-6,\n \"JPY\":14.0867,\n \"USD\":0.127427,\n \"ILS\":0.460862,\n \"EUR\":0.112495\n },\n \"AUD\":{\n \"XAF\":438.162,\n \"HKD\":5.61346,\n \"AUD\":1.0,\n \"KRW\":895.304,\n \"JOD\":0.556152,\n \"GBP\":0.609788,\n \"MXN\":16.0826,\n \"AED\":2.88368,\n \"INR\":50.4238,\n \"XBT\":1.2284055924E-5,\n \"JPY\":87.0936,\n \"USD\":0.785256,\n \"ILS\":2.83558,\n \"EUR\":0.667969\n },\n \"KRW\":{\n \"XAF\":0.531986,\n \"HKD\":0.00697233,\n \"AUD\":0.00111694,\n \"KRW\":1.0,\n \"JOD\":6.30634E-4,\n \"GBP\":6.97389E-4,\n \"MXN\":0.0183,\n \"AED\":0.00320019,\n \"INR\":0.0586469,\n \"XBT\":1.4234725E-8,\n \"JPY\":0.0985917,\n \"USD\":8.7125E-4,\n \"ILS\":0.00316552,\n \"EUR\":8.11008E-4\n },\n \"JOD\":{\n \"XAF\":782.572,\n \"HKD\":11.0687,\n \"AUD\":1.63992,\n \"KRW\":1585.68,\n \"JOD\":1.0,\n \"GBP\":1.06757,\n \"MXN\":30.8336,\n \"AED\":5.18231,\n \"INR\":90.1236,\n \"XBT\":2.3803244006E-5,\n \"JPY\":156.304,\n \"USD\":1.41112,\n \"ILS\":5.02018,\n \"EUR\":0.237707\n },\n \"GBP\":{\n \"XAF\":762.826,\n \"HKD\":10.1468,\n \"AUD\":1.63992,\n \"KRW\":1433.92,\n \"JOD\":0.936707,\n \"GBP\":1.0,\n \"MXN\":29.242,\n \"AED\":4.58882,\n \"INR\":84.095,\n \"XBT\":2.2756409956E-5,\n \"JPY\":141.373,\n \"USD\":1.2493,\n \"ILS\":4.7002,\n \"EUR\":1.16278\n },\n \"MXN\":{\n \"XAF\":25.189,\n \"HKD\":0.3562,\n \"AUD\":0.0621,\n \"KRW\":54.4512,\n \"JOD\":0.0324,\n \"GBP\":0.0341,\n \"MXN\":1.0,\n \"AED\":0.1688,\n \"INR\":3.3513,\n \"XBT\":8.1112586E-7,\n \"JPY\":4.8687,\n \"USD\":0.0459,\n \"ILS\":0.1541,\n \"EUR\":0.0384\n },\n \"AED\":{\n \"XAF\":166.236,\n \"HKD\":2.13685,\n \"AUD\":0.346779,\n \"KRW\":312.482,\n \"JOD\":0.1930565,\n \"GBP\":0.217921,\n \"MXN\":5.9217,\n \"AED\":1.0,\n \"INR\":18.3255,\n \"XBT\":4.603349217E-6,\n \"JPY\":30.8081,\n \"USD\":0.27225,\n \"ILS\":0.968033,\n \"EUR\":0.253425\n },\n \"INR\":{\n \"XAF\":9.07101,\n \"HKD\":0.109972,\n \"AUD\":0.0198319,\n \"KRW\":17.0512,\n \"JOD\":0.0110959,\n \"GBP\":0.0118913,\n \"MXN\":0.2983,\n \"AED\":0.0545671,\n \"INR\":1.0,\n \"XBT\":2.2689396E-7,\n \"JPY\":1.68111,\n \"USD\":0.0148559,\n \"ILS\":0.0556764,\n \"EUR\":0.0138287\n },\n \"XBT\":{\n \"XAF\":3.4353824E7,\n \"HKD\":460448.9,\n \"AUD\":81168.603,\n \"KRW\":7.0131575E7,\n \"JOD\":41960.111,\n \"GBP\":44188.118,\n \"MXN\":1230503.3,\n \"AED\":217414.47,\n \"INR\":4407607.74,\n \"XBT\":1.0,\n \"JPY\":6805170.8,\n \"USD\":59245.918,\n \"ILS\":182981.21,\n \"EUR\":52436.431\n },\n \"JPY\":{\n \"XAF\":5.39585,\n \"HKD\":0.0709891,\n \"AUD\":0.0114819,\n \"KRW\":10.1428,\n \"JOD\":0.00639777,\n \"GBP\":0.0070735,\n \"MXN\":0.2053,\n \"AED\":0.032459,\n \"INR\":0.594846,\n \"XBT\":1.47171931E-7,\n \"JPY\":1.0,\n \"USD\":0.00883695,\n \"ILS\":0.0320926,\n \"EUR\":0.00822592\n },\n \"USD\":{\n \"XAF\":610.601,\n \"HKD\":7.84766,\n \"AUD\":1.27347,\n \"KRW\":1147.78,\n \"JOD\":0.708659,\n \"GBP\":0.800446,\n \"MXN\":21.748,\n \"AED\":3.6731,\n \"INR\":67.3135,\n \"XBT\":1.69154E-5,\n \"JPY\":113.161,\n \"USD\":1.0,\n \"ILS\":3.55495,\n \"EUR\":0.930886\n },\n \"ILS\":{\n \"XAF\":155.925,\n \"HKD\":2.16985,\n \"AUD\":0.352661,\n \"KRW\":315.903,\n \"JOD\":0.199196,\n \"GBP\":0.212763,\n \"MXN\":6.4871,\n \"AED\":1.03302,\n \"INR\":17.9609,\n \"XBT\":5.452272147E-6,\n \"JPY\":31.1599,\n \"USD\":0.281298,\n \"ILS\":1.0,\n \"EUR\":1.19318\n },\n \"EUR\":{\n \"XAF\":655.957,\n \"HKD\":8.88926,\n \"AUD\":1.49707,\n \"KRW\":1233.03,\n \"JOD\":0.838098,\n \"GBP\":0.860011,\n \"MXN\":26.0359,\n \"AED\":3.94594,\n \"INR\":72.3136,\n \"XBT\":1.9087905636E-5,\n \"JPY\":121.567,\n \"USD\":1.07428,\n \"ILS\":4.20494,\n \"EUR\":1.0\n }\n}\n\n\nTransaction Requests satisfy PSD2 requirements thus:\n\n1) A transaction can be initiated by a third party application.\n\n2) The customer is informed of the charge that will incurred.\n\n3) The call supports delegated authentication (OAuth)\n\nSee [this python code](https://github.com/OpenBankProject/Hello-OBP-DirectLogin-Python/blob/master/hello_payments.py) for a complete example of this flow.\n\nThere is further documentation [here](https://github.com/OpenBankProject/OBP-API/wiki/Transaction-Requests)\n\nAuthentication is Mandatory\n\n\n**URL Parameters:**\n\n[ACCOUNT_ID](/glossary#Account.account_id): 8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0\n\n\n\n[BANK_ID](/glossary#Bank.bank_id): gh.29.uk\n\n\n\n[SANDBOX_TAN](/glossary#sandbox_tan): \n\n\n\n[VIEW_ID](/glossary#this_view_id): owner\n\n\n\n\n\n**JSON request body fields:**\n\n\n\n[**account_id**](/glossary#): 8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0\n\n\n\n[**amount**](/glossary#): 10.12\n\n\n\n[**bank_id**](/glossary#): gh.29.uk\n\n\n\n[**currency**](/glossary#): EUR\n\n\n\n[**description**](/glossary#description): This an optional field. Maximum length is 2000. It can be any characters here.\n\n\n\n[**to**](/glossary#to): \n\n\n\n[**value**](/glossary#): 5987953\n\n\n\n\n\n**JSON response body fields:**\n\n\n\n[**account**](/glossary#Account): \n\n\n\n[**account_id**](/glossary#): 8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0\n\n\n\n[**allowed_attempts**](/glossary#allowed_attempts): 5\n\n\n\n[**amount**](/glossary#): 10.12\n\n\n\n[**bank_code**](/glossary#bank_code): CGHZ\n\n\n\n[**bank_id**](/glossary#): gh.29.uk\n\n\n\n[**branch_number**](/glossary#branch_number): \n\n\n\n[**challenge**](/glossary#challenge): \n\n\n\n[**challenge_type**](/glossary#challenge_type): \n\n\n\n[**charge**](/glossary#charge): \n\n\n\n[**counterparty_id**](/glossary#): 9fg8a7e4-6d02-40e3-a129-0b2bf89de8uh\n\n\n\n[**creditorAccount**](/glossary#creditoraccount): \n\n\n\n[**creditorName**](/glossary#creditorname): \n\n\n\n[**currency**](/glossary#): EUR\n\n\n\n[**date_of_birth**](/glossary#): 2018-03-09\n\n\n\n[**debtorAccount**](/glossary#debtoraccount): \n\n\n\n[**description**](/glossary#description): This an optional field. Maximum length is 2000. It can be any characters here.\n\n\n\n[**details**](/glossary#details): \n\n\n\n[**end_date**](/glossary#end_date): \n\n\n\n[**from**](/glossary#from): \n\n\n\n[**future_date**](/glossary#future_date): 20200127\n\n\n\n[**iban**](/glossary#): DE91 1000 0000 0123 4567 89\n\n\n\n[**id**](/glossary#id): d8839721-ad8f-45dd-9f78-2080414b93f9\n\n\n\n[**instructedAmount**](/glossary#instructedamount): 100\n\n\n\n[**kyc_document**](/glossary#kyc_document): \n\n\n\n[**legal_name**](/glossary#): Eveline Tripman\n\n\n\n[**message**](/glossary#message): 123456\n\n\n\n[**mobile_phone_number**](/glossary#mobile_phone_number): +49 30 901820\n\n\n\n[**name**](/glossary#name): ACCOUNT_MANAGEMENT_FEE\n\n\n\n[**nickname**](/glossary#nickname): \n\n\n\n[**number**](/glossary#number): \n\n\n\n[**otherAccountRoutingAddress**](/glossary#): otherAccountRoutingAddress\n\n\n\n[**otherAccountRoutingScheme**](/glossary#): otherAccountRoutingScheme\n\n\n\n[**otherAccountSecondaryRoutingAddress**](/glossary#): otherAccountSecondaryRoutingAddress\n\n\n\n[**otherAccountSecondaryRoutingScheme**](/glossary#): otherAccountSecondaryRoutingScheme\n\n\n\n[**otherBankRoutingAddress**](/glossary#): otherBankRoutingAddress\n\n\n\n[**otherBankRoutingScheme**](/glossary#): otherBankRoutingScheme\n\n\n\n[**otherBranchRoutingAddress**](/glossary#): otherBranchRoutingAddress\n\n\n\n[**otherBranchRoutingScheme**](/glossary#): otherBranchRoutingScheme\n\n\n\n[**start_date**](/glossary#): 2020-01-27\n\n\n\n[**status**](/glossary#status): \n\n\n\n[**summary**](/glossary#summary): \n\n\n\n[**to**](/glossary#to): \n\n\n\n[**transaction_ids**](/glossary#transaction_ids): \n\n\n\n[**transfer_type**](/glossary#transfer_type): \n\n\n\n[**type**](/glossary#type): \n\n\n\n[**value**](/glossary#): 5987953\n\n\n\n[to_counterparty](/glossary#to_counterparty): \n\n\n\n[to_sandbox_tan](/glossary#to_sandbox_tan): \n\n\n\n[to_sepa](/glossary#to_sepa): \n\n\n\n[to_sepa_credit_transfers](/glossary#to_sepa_credit_transfers): \n\n\n\n[to_simple](/glossary#): to_simple\n\n\n\n[to_transfer_to_account](/glossary#to_transfer_to_account): \n\n\n\n[to_transfer_to_atm](/glossary#to_transfer_to_atm): \n\n\n\n[to_transfer_to_phone](/glossary#to_transfer_to_phone): \n\n\n","example_request_body":{"to":{"bank_id":"gh.29.uk","account_id":"8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0"},"value":{"currency":"EUR","amount":"0"},"description":"this is for work"},"success_response_body":{"id":"4050046c-63b3-4868-8a22-14b4181d33a6","type":"SANDBOX_TAN","from":{"bank_id":"gh.29.uk","account_id":"8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0"},"details":{"to_sandbox_tan":{"bank_id":"String","account_id":"String"},"to_sepa":{"iban":"String"},"to_counterparty":{"counterparty_id":"9fg8a7e4-6d02-40e3-a129-0b2bf89de8uh"},"to_simple":{"otherBankRoutingScheme":"BIC","otherBankRoutingAddress":"GENODEM1GLS","otherBranchRoutingScheme":"BRANCH-CODE","otherBranchRoutingAddress":"DERBY6","otherAccountRoutingScheme":"IBAN","otherAccountRoutingAddress":"DE91 1000 0000 0123 4567 89","otherAccountSecondaryRoutingScheme":"IBAN","otherAccountSecondaryRoutingAddress":"DE91 1000 0000 0123 4567 89"},"to_transfer_to_phone":{"value":{"currency":"EUR","amount":"0"},"description":"String","message":"String","from":{"mobile_phone_number":"+44 07972 444 876","nickname":"String"},"to":{"mobile_phone_number":"+44 07972 444 876"}},"to_transfer_to_atm":{"value":{"currency":"EUR","amount":"0"},"description":"String","message":"String","from":{"mobile_phone_number":"+44 07972 444 876","nickname":"String"},"to":{"legal_name":"Eveline Tripman","date_of_birth":"20181230","mobile_phone_number":"+44 07972 444 876","kyc_document":{"type":"String","number":"String"}}},"to_transfer_to_account":{"value":{"currency":"EUR","amount":"0"},"description":"String","transfer_type":"String","future_date":"20181230","to":{"name":"String","bank_code":"String","branch_number":"String","account":{"number":"String","iban":"String"}}},"to_sepa_credit_transfers":{"debtorAccount":{"iban":"12345"},"instructedAmount":{"currency":"EUR","amount":"0"},"creditorAccount":{"iban":"54321"},"creditorName":"John Miles"},"value":{"currency":"EUR","amount":"100"},"description":"This an optional field. Maximum length is 2000. It can be any characters here."},"transaction_ids":["902ba3bb-dedd-45e7-9319-2fd3f2cd98a1"],"status":"COMPLETED","start_date":"1100-01-01T00:00:00Z","end_date":"1100-01-01T00:00:00Z","challenge":{"id":"be1a183d-b301-4b83-b855-5eeffdd3526f","allowed_attempts":3,"challenge_type":"SANDBOX_TAN"},"charge":{"summary":"Rent the flat","value":{"currency":"EUR","amount":"0"}}},"error_response_bodies":["OBP-20001: User not logged in. Authentication is required!","OBP-20001: User not logged in. Authentication is required!","OBP-30111: Invalid Bank Id. The BANK_ID should only contain 0-9/a-z/A-Z/'-'/'.'/'_', the length should be smaller than 255.","OBP-30110: Invalid Account Id. The ACCOUNT_ID should only contain 0-9/a-z/A-Z/'-'/'.'/'_', the length should be smaller than 255.","OBP-10001: Incorrect json format.","OBP-30001: Bank not found. Please specify a valid value for BANK_ID.","OBP-30003: Account not found. Please specify a valid value for ACCOUNT_ID.","OBP-30005: View not found for Account. Please specify a valid value for VIEW_ID","OBP-40002: Insufficient authorisation to create TransactionRequest. The Transaction Request could not be created because the login user doesn't have access to the view of the from account or the consumer doesn't have the access to the view of the from account or the login user does not have the `CanCreateAnyTransactionRequest` role or the view does not have the permission canaddtransactionrequesttoanyaccount.","OBP-20017: Current user does not have access to the view. Please specify a valid value for VIEW_ID.","OBP-40001: Invalid value for TRANSACTION_REQUEST_TYPE","OBP-10001: Incorrect json format.","OBP-10002: Invalid Number. Could not convert value to a number.","OBP-40008: Can't send a payment with a value of 0 or less.","OBP-40003: Transaction Request Currency must be the same as From Account Currency.","OBP-00003: Transaction Requests is disabled in this API instance.","OBP-50000: Unknown Error."],"tags":["Transaction-Request","Payment Initiation Service (PIS)","PSD2"],"typed_request_body":{"type":"object","properties":{"to":{"type":"object","properties":{"bank_id":{"type":"string"},"account_id":{"type":"string"}}},"description":{"type":"string"},"value":{"type":"object","properties":{"currency":{"type":"string"},"amount":{"type":"string"}}}}},"typed_success_response_body":{"type":"object","properties":{"type":{"type":"string"},"challenge":{"type":"object","properties":{"challenge_type":{"type":"string"},"allowed_attempts":{"type":"integer"},"id":{"type":"string"}}},"status":{"type":"string"},"end_date":{"type":"string","format":"date-time"},"charge":{"type":"object","properties":{"summary":{"type":"string"},"value":{"type":"object","properties":{"currency":{"type":"string"},"amount":{"type":"string"}}}}},"transaction_ids":{"type":"array","items":{"type":"string"}},"from":{"type":"object","properties":{"bank_id":{"type":"string"},"account_id":{"type":"string"}}},"details":{"type":"object","properties":{"description":{"type":"string"},"to_sandbox_tan":{"type":"object","properties":{"account_id":{"type":"string"},"bank_id":{"type":"string"}}},"value":{"type":"object","properties":{"currency":{"type":"string"},"amount":{"type":"string"}}},"to_transfer_to_phone":{"type":"object","properties":{"description":{"type":"string"},"message":{"type":"string"},"from":{"type":"object","properties":{"nickname":{"type":"string"},"mobile_phone_number":{"type":"string"}}},"to":{"type":"object","properties":{"mobile_phone_number":{"type":"string"}}},"value":{"type":"object","properties":{"currency":{"type":"string"},"amount":{"type":"string"}}}}},"to_sepa":{"type":"object","properties":{"iban":{"type":"string"}}},"to_simple":{"type":"object","properties":{"otherBankRoutingAddress":{"type":"string"},"otherAccountSecondaryRoutingAddress":{"type":"string"},"otherBranchRoutingScheme":{"type":"string"},"otherAccountRoutingScheme":{"type":"string"},"otherAccountRoutingAddress":{"type":"string"},"otherBankRoutingScheme":{"type":"string"},"otherBranchRoutingAddress":{"type":"string"},"otherAccountSecondaryRoutingScheme":{"type":"string"}}},"to_counterparty":{"type":"object","properties":{"counterparty_id":{"type":"string"}}},"to_transfer_to_account":{"type":"object","properties":{"to":{"type":"object","properties":{"name":{"type":"string"},"account":{"type":"object","properties":{"number":{"type":"string"},"iban":{"type":"string"}}},"bank_code":{"type":"string"},"branch_number":{"type":"string"}}},"transfer_type":{"type":"string"},"description":{"type":"string"},"future_date":{"type":"string"},"value":{"type":"object","properties":{"currency":{"type":"string"},"amount":{"type":"string"}}}}},"to_sepa_credit_transfers":{"type":"object","properties":{"instructedAmount":{"type":"object","properties":{"currency":{"type":"string"},"amount":{"type":"string"}}},"debtorAccount":{"type":"object","properties":{"iban":{"type":"string"}}},"creditorAccount":{"type":"object","properties":{"iban":{"type":"string"}}},"creditorName":{"type":"string"}}},"to_transfer_to_atm":{"type":"object","properties":{"description":{"type":"string"},"message":{"type":"string"},"from":{"type":"object","properties":{"nickname":{"type":"string"},"mobile_phone_number":{"type":"string"}}},"value":{"type":"object","properties":{"currency":{"type":"string"},"amount":{"type":"string"}}},"to":{"type":"object","properties":{"date_of_birth":{"type":"string"},"kyc_document":{"type":"object","properties":{"type":{"type":"string"},"number":{"type":"string"}}},"legal_name":{"type":"string"},"mobile_phone_number":{"type":"string"}}}}}}},"start_date":{"type":"string","format":"date-time"},"id":{"type":"string"}}},"is_featured":false,"special_instructions":"","specified_url":"/obp/v4.0.0/banks/BANK_ID/accounts/ACCOUNT_ID/VIEW_ID/transaction-request-types/SANDBOX_TAN/transaction-requests","connector_methods":[]},{"operation_id":"OBPv4.0.0-createOrUpdateTransactionRequestAttributeDefinition","implemented_by":{"version":"OBPv4.0.0","function":"createOrUpdateTransactionRequestAttributeDefinition"},"request_verb":"PUT","request_url":"/obp/v4.0.0/banks/BANK_ID/attribute-definitions/transaction-request","summary":"Create or Update Transaction Request Attribute Definition","description":"Create or Update Transaction Request Attribute Definition
\nThe category field must be TransactionRequest
\nThe type field must be one of: DOUBLE, STRING, INTEGER and DATE_WITH_DAY
\nAuthentication is Mandatory
\nURL Parameters:
\nBANK_ID: gh.29.uk
\nJSON response body fields:
\n\n\nbank_id: gh.29.uk
\ncan_be_seen_on_views: true
\n\ndescription: This an optional field. Maximum length is 2000. It can be any characters here.
\nis_active: true
\nname: ACCOUNT_MANAGEMENT_FEE
\ntype:
\n","description_markdown":"Create or Update Transaction Request Attribute Definition\n\nThe category field must be TransactionRequest\n\nThe type field must be one of: DOUBLE, STRING, INTEGER and DATE_WITH_DAY\n\nAuthentication is Mandatory\n\n\n**URL Parameters:**\n\n[BANK_ID](/glossary#Bank.bank_id): gh.29.uk\n\n\n\n\n\n**JSON response body fields:**\n\n\n\n[**alias**](/glossary#alias): \n\n\n\n[**attribute_definition_id**](/glossary#attribute_definition_id): \n\n\n\n[**bank_id**](/glossary#): gh.29.uk\n\n\n\n[**can_be_seen_on_views**](/glossary#can_be_seen_on_views): true\n\n\n\n[**category**](/glossary#category): \n\n\n\n[**description**](/glossary#description): This an optional field. Maximum length is 2000. It can be any characters here.\n\n\n\n[**is_active**](/glossary#is_active): true\n\n\n\n[**name**](/glossary#name): ACCOUNT_MANAGEMENT_FEE\n\n\n\n[**type**](/glossary#type): \n\n\n","example_request_body":{"name":"SPECIAL_TAX_NUMBER","category":"TransactionRequest","type":"STRING","description":"description","alias":"STRING","can_be_seen_on_views":["bank"],"is_active":true},"success_response_body":{"attribute_definition_id":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1","bank_id":"gh.29.uk","name":"SPECIAL_TAX_NUMBER","category":"TransactionRequest","type":"STRING","description":"description","alias":"STRING","can_be_seen_on_views":["bank"],"is_active":true},"error_response_bodies":["OBP-20001: User not logged in. Authentication is required!","OBP-30001: Bank not found. Please specify a valid value for BANK_ID.","OBP-10001: Incorrect json format.","OBP-50000: Unknown Error.","OBP-20006: User is missing one or more roles: "],"tags":["Transaction-Request"],"typed_request_body":{"type":"object","properties":{"can_be_seen_on_views":{"type":"array","items":{"type":"string"}},"description":{"type":"string"},"is_active":{"type":"boolean"},"name":{"type":"string"},"type":{"type":"string"},"category":{"type":"string"},"alias":{"type":"string"}}},"typed_success_response_body":{"type":"object","properties":{"can_be_seen_on_views":{"type":"array","items":{"type":"string"}},"attribute_definition_id":{"type":"string"},"description":{"type":"string"},"is_active":{"type":"boolean"},"bank_id":{"type":"string"},"name":{"type":"string"},"type":{"type":"string"},"category":{"type":"string"},"alias":{"type":"string"}}},"roles":[{"role":"CanCreateTransactionRequestAttributeDefinitionAtOneBank","requires_bank_id":true}],"is_featured":false,"special_instructions":"","specified_url":"/obp/v4.0.0/banks/BANK_ID/attribute-definitions/transaction-request","connector_methods":[]},{"operation_id":"OBPv4.0.0-getTransactionRequestAttributeDefinition","implemented_by":{"version":"OBPv4.0.0","function":"getTransactionRequestAttributeDefinition"},"request_verb":"GET","request_url":"/obp/v4.0.0/banks/BANK_ID/attribute-definitions/transaction-request","summary":"Get Transaction Request Attribute Definition","description":"Get Transaction Request Attribute Definition
\nAuthentication is Mandatory
\nURL Parameters:
\nBANK_ID: gh.29.uk
\nJSON response body fields:
\n\n\nattributes: attribute value in form of (name, value)
\nbank_id: gh.29.uk
\ncan_be_seen_on_views: true
\n\ndescription: This an optional field. Maximum length is 2000. It can be any characters here.
\nis_active: true
\nname: ACCOUNT_MANAGEMENT_FEE
\ntype:
\n","description_markdown":"Get Transaction Request Attribute Definition\n\nAuthentication is Mandatory\n\n\n**URL Parameters:**\n\n[BANK_ID](/glossary#Bank.bank_id): gh.29.uk\n\n\n\n\n\n**JSON response body fields:**\n\n\n\n[**alias**](/glossary#alias): \n\n\n\n[**attribute_definition_id**](/glossary#attribute_definition_id): \n\n\n\n[**attributes**](/glossary#attributes): attribute value in form of (name, value)\n\n\n\n[**bank_id**](/glossary#): gh.29.uk\n\n\n\n[**can_be_seen_on_views**](/glossary#can_be_seen_on_views): true\n\n\n\n[**category**](/glossary#category): \n\n\n\n[**description**](/glossary#description): This an optional field. Maximum length is 2000. It can be any characters here.\n\n\n\n[**is_active**](/glossary#is_active): true\n\n\n\n[**name**](/glossary#name): ACCOUNT_MANAGEMENT_FEE\n\n\n\n[**type**](/glossary#type): \n\n\n","success_response_body":{"attributes":[{"attribute_definition_id":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1","bank_id":"gh.29.uk","name":"SPECIAL_TAX_NUMBER","category":"TransactionRequest","type":"STRING","description":"description","alias":"STRING","can_be_seen_on_views":["bank"],"is_active":true}]},"error_response_bodies":["OBP-20001: User not logged in. Authentication is required!","OBP-30001: Bank not found. Please specify a valid value for BANK_ID.","OBP-50000: Unknown Error.","OBP-20006: User is missing one or more roles: "],"tags":["Transaction-Request"],"typed_success_response_body":{"type":"object","properties":{"attributes":{"type":"array","items":{"type":"object","properties":{"can_be_seen_on_views":{"type":"array","items":{"type":"string"}},"attribute_definition_id":{"type":"string"},"description":{"type":"string"},"is_active":{"type":"boolean"},"bank_id":{"type":"string"},"name":{"type":"string"},"type":{"type":"string"},"category":{"type":"string"},"alias":{"type":"string"}}}}}},"roles":[{"role":"CanGetTransactionRequestAttributeDefinitionAtOneBank","requires_bank_id":true}],"is_featured":false,"special_instructions":"","specified_url":"/obp/v4.0.0/banks/BANK_ID/attribute-definitions/transaction-request","connector_methods":[]},{"operation_id":"OBPv4.0.0-createTransactionRequestFreeForm","implemented_by":{"version":"OBPv4.0.0","function":"createTransactionRequestFreeForm"},"request_verb":"POST","request_url":"/obp/v4.0.0/banks/BANK_ID/accounts/ACCOUNT_ID/VIEW_ID/transaction-request-types/FREE_FORM/transaction-requests","summary":"Create Transaction Request (FREE_FORM)","description":"Initiate a Payment via creating a Transaction Request.
\nIn OBP, a transaction request
may or may not result in a transaction
. However, a transaction
only has one possible state: completed.
A Transaction Request
can have one of several states: INITIATED, NEXT_CHALLENGE_PENDING etc.
Transactions
are modeled on items in a bank statement that represent the movement of money.
Transaction Requests
are requests to move money which may or may not succeed and thus result in a Transaction
.
A Transaction Request
might create a security challenge that needs to be answered before the Transaction Request
proceeds.
\nIn case 1 person needs to answer security challenge we have next flow of state of an transaction request
:
\nINITIATED => COMPLETED
\nIn case n persons needs to answer security challenge we have next flow of state of an transaction request
:
\nINITIATED => NEXT_CHALLENGE_PENDING => ... => NEXT_CHALLENGE_PENDING => COMPLETED
The security challenge is bound to a user i.e. in case of right answer and the user is different than expected one the challenge will fail.
\nRule for calculating number of security challenges:
\nIf product Account attribute REQUIRED_CHALLENGE_ANSWERS=N then create N challenges
\n(one for every user that has a View where permission "can_add_transaction_request_to_any_account"=true)
\nIn case REQUIRED_CHALLENGE_ANSWERS is not defined as an account attribute default value is 1.
Transaction Requests contain charge information giving the client the opportunity to proceed or not (as long as the challenge level is appropriate).
\nTransaction Requests can have one of several Transaction Request Types which expect different bodies. The escaped body is returned in the details key of the GET response.
\nThis provides some commonality and one URL for many different payment or transfer types with enough flexibility to validate them differently.
The payer is set in the URL. Money comes out of the BANK_ID and ACCOUNT_ID specified in the URL.
\nIn sandbox mode, TRANSACTION_REQUEST_TYPE is commonly set to ACCOUNT. See getTransactionRequestTypesSupportedByBank for all supported types.
\nIn sandbox mode, if the amount is less than 1000 EUR (any currency, unless it is set differently on this server), the transaction request will create a transaction without a challenge, else the Transaction Request will be set to INITIALISED and a challenge will need to be answered.
\nIf a challenge is created you must answer it using Answer Transaction Request Challenge before the Transaction is created.
\nYou can transfer between different currency accounts. (new in 2.0.0). The currency in body must match the sending account.
\nThe following static FX rates are available in sandbox mode:
\n\nTransaction Requests satisfy PSD2 requirements thus:
\n1) A transaction can be initiated by a third party application.
\n2) The customer is informed of the charge that will incurred.
\n3) The call supports delegated authentication (OAuth)
\nSee this python code for a complete example of this flow.
\nThere is further documentation here
\nAuthentication is Mandatory
\nURL Parameters:
\nACCOUNT_ID: 8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0
\nBANK_ID: gh.29.uk
\n\nVIEW_ID: owner
\nJSON request body fields:
\namount: 10.12
\ncurrency: EUR
\ndescription: This an optional field. Maximum length is 2000. It can be any characters here.
\nvalue: 5987953
\nJSON response body fields:
\n\naccount_id: 8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0
\n\namount: 10.12
\nbank_code: CGHZ
\nbank_id: gh.29.uk
\n\n\nchallenges: challenges
\n\ncounterparty_id: 9fg8a7e4-6d02-40e3-a129-0b2bf89de8uh
\n\n\ncurrency: EUR
\ndate_of_birth: 2018-03-09
\n\ndescription: This an optional field. Maximum length is 2000. It can be any characters here.
\n\n\nfrom:
\nfuture_date: 20200127
\niban: DE91 1000 0000 0123 4567 89
\nid: d8839721-ad8f-45dd-9f78-2080414b93f9
\ninstructedAmount: 100
\n\nlegal_name: Eveline Tripman
\nlink:
\nmessage: 123456
\nmobile_phone_number: +49 30 901820
\nname: ACCOUNT_MANAGEMENT_FEE
\n\n\notherAccountRoutingAddress: otherAccountRoutingAddress
\notherAccountRoutingScheme: otherAccountRoutingScheme
\notherAccountSecondaryRoutingAddress: otherAccountSecondaryRoutingAddress
\notherAccountSecondaryRoutingScheme: otherAccountSecondaryRoutingScheme
\notherBankRoutingAddress: otherBankRoutingAddress
\notherBankRoutingScheme: otherBankRoutingScheme
\notherBranchRoutingAddress: otherBranchRoutingAddress
\notherBranchRoutingScheme: otherBranchRoutingScheme
\nstart_date: 2020-01-27
\n\n\nto:
\n\n\ntype:
\nuser_id: 9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1
\nvalue: 5987953
\n\n\n\n\nto_simple: to_simple
\n\n\n\n","description_markdown":"Initiate a Payment via creating a Transaction Request.\n\nIn OBP, a `transaction request` may or may not result in a `transaction`. However, a `transaction` only has one possible state: completed.\n\nA `Transaction Request` can have one of several states: INITIATED, NEXT_CHALLENGE_PENDING etc.\n\n`Transactions` are modeled on items in a bank statement that represent the movement of money.\n\n`Transaction Requests` are requests to move money which may or may not succeed and thus result in a `Transaction`.\n\nA `Transaction Request` might create a security challenge that needs to be answered before the `Transaction Request` proceeds.\nIn case 1 person needs to answer security challenge we have next flow of state of an `transaction request`:\n INITIATED => COMPLETED\nIn case n persons needs to answer security challenge we have next flow of state of an `transaction request`:\n INITIATED => NEXT_CHALLENGE_PENDING => ... => NEXT_CHALLENGE_PENDING => COMPLETED\n\nThe security challenge is bound to a user i.e. in case of right answer and the user is different than expected one the challenge will fail.\n\nRule for calculating number of security challenges:\nIf product Account attribute REQUIRED_CHALLENGE_ANSWERS=N then create N challenges\n(one for every user that has a View where permission \"can_add_transaction_request_to_any_account\"=true)\nIn case REQUIRED_CHALLENGE_ANSWERS is not defined as an account attribute default value is 1.\n\nTransaction Requests contain charge information giving the client the opportunity to proceed or not (as long as the challenge level is appropriate).\n\nTransaction Requests can have one of several Transaction Request Types which expect different bodies. The escaped body is returned in the details key of the GET response.\nThis provides some commonality and one URL for many different payment or transfer types with enough flexibility to validate them differently.\n\nThe payer is set in the URL. Money comes out of the BANK_ID and ACCOUNT_ID specified in the URL.\n\nIn sandbox mode, TRANSACTION_REQUEST_TYPE is commonly set to ACCOUNT. See getTransactionRequestTypesSupportedByBank for all supported types.\n\nIn sandbox mode, if the amount is less than 1000 EUR (any currency, unless it is set differently on this server), the transaction request will create a transaction without a challenge, else the Transaction Request will be set to INITIALISED and a challenge will need to be answered.\n\nIf a challenge is created you must answer it using Answer Transaction Request Challenge before the Transaction is created.\n\nYou can transfer between different currency accounts. (new in 2.0.0). The currency in body must match the sending account.\n\nThe following static FX rates are available in sandbox mode:\n\nhttps://apiexplorer-ii-sandbox.openbankproject.com//more?version=OBPv4.0.0&list-all-banks=false&core=&psd2=&obwg=#OBPv2_2_0-getCurrentFxRate\n\n\nTransaction Requests satisfy PSD2 requirements thus:\n\n1) A transaction can be initiated by a third party application.\n\n2) The customer is informed of the charge that will incurred.\n\n3) The call supports delegated authentication (OAuth)\n\nSee [this python code](https://github.com/OpenBankProject/Hello-OBP-DirectLogin-Python/blob/master/hello_payments.py) for a complete example of this flow.\n\nThere is further documentation [here](https://github.com/OpenBankProject/OBP-API/wiki/Transaction-Requests)\n\n\n\n \n\nAuthentication is Mandatory\n\n\n**URL Parameters:**\n\n[ACCOUNT_ID](/glossary#Account.account_id): 8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0\n\n\n\n[BANK_ID](/glossary#Bank.bank_id): gh.29.uk\n\n\n\n[FREE_FORM](/glossary#free_form): \n\n\n\n[VIEW_ID](/glossary#this_view_id): owner\n\n\n\n\n\n**JSON request body fields:**\n\n\n\n[**amount**](/glossary#): 10.12\n\n\n\n[**currency**](/glossary#): EUR\n\n\n\n[**description**](/glossary#description): This an optional field. Maximum length is 2000. It can be any characters here.\n\n\n\n[**value**](/glossary#): 5987953\n\n\n\n\n\n**JSON response body fields:**\n\n\n\n[**account**](/glossary#Account): \n\n\n\n[**account_id**](/glossary#): 8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0\n\n\n\n[**allowed_attempts**](/glossary#allowed_attempts): 5\n\n\n\n[**amount**](/glossary#): 10.12\n\n\n\n[**bank_code**](/glossary#bank_code): CGHZ\n\n\n\n[**bank_id**](/glossary#): gh.29.uk\n\n\n\n[**branch_number**](/glossary#branch_number): \n\n\n\n[**challenge_type**](/glossary#challenge_type): \n\n\n\n[**challenges**](/glossary#): challenges\n\n\n\n[**charge**](/glossary#charge): \n\n\n\n[**counterparty_id**](/glossary#): 9fg8a7e4-6d02-40e3-a129-0b2bf89de8uh\n\n\n\n[**creditorAccount**](/glossary#creditoraccount): \n\n\n\n[**creditorName**](/glossary#creditorname): \n\n\n\n[**currency**](/glossary#): EUR\n\n\n\n[**date_of_birth**](/glossary#): 2018-03-09\n\n\n\n[**debtorAccount**](/glossary#debtoraccount): \n\n\n\n[**description**](/glossary#description): This an optional field. Maximum length is 2000. It can be any characters here.\n\n\n\n[**details**](/glossary#details): \n\n\n\n[**end_date**](/glossary#end_date): \n\n\n\n[**from**](/glossary#from): \n\n\n\n[**future_date**](/glossary#future_date): 20200127\n\n\n\n[**iban**](/glossary#): DE91 1000 0000 0123 4567 89\n\n\n\n[**id**](/glossary#id): d8839721-ad8f-45dd-9f78-2080414b93f9\n\n\n\n[**instructedAmount**](/glossary#instructedamount): 100\n\n\n\n[**kyc_document**](/glossary#kyc_document): \n\n\n\n[**legal_name**](/glossary#): Eveline Tripman\n\n\n\n[**link**](/glossary#link): \n\n\n\n[**message**](/glossary#message): 123456\n\n\n\n[**mobile_phone_number**](/glossary#mobile_phone_number): +49 30 901820\n\n\n\n[**name**](/glossary#name): ACCOUNT_MANAGEMENT_FEE\n\n\n\n[**nickname**](/glossary#nickname): \n\n\n\n[**number**](/glossary#number): \n\n\n\n[**otherAccountRoutingAddress**](/glossary#): otherAccountRoutingAddress\n\n\n\n[**otherAccountRoutingScheme**](/glossary#): otherAccountRoutingScheme\n\n\n\n[**otherAccountSecondaryRoutingAddress**](/glossary#): otherAccountSecondaryRoutingAddress\n\n\n\n[**otherAccountSecondaryRoutingScheme**](/glossary#): otherAccountSecondaryRoutingScheme\n\n\n\n[**otherBankRoutingAddress**](/glossary#): otherBankRoutingAddress\n\n\n\n[**otherBankRoutingScheme**](/glossary#): otherBankRoutingScheme\n\n\n\n[**otherBranchRoutingAddress**](/glossary#): otherBranchRoutingAddress\n\n\n\n[**otherBranchRoutingScheme**](/glossary#): otherBranchRoutingScheme\n\n\n\n[**start_date**](/glossary#): 2020-01-27\n\n\n\n[**status**](/glossary#status): \n\n\n\n[**summary**](/glossary#summary): \n\n\n\n[**to**](/glossary#to): \n\n\n\n[**transaction_ids**](/glossary#transaction_ids): \n\n\n\n[**transfer_type**](/glossary#transfer_type): \n\n\n\n[**type**](/glossary#type): \n\n\n\n[**user_id**](/glossary#): 9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1\n\n\n\n[**value**](/glossary#): 5987953\n\n\n\n[to_counterparty](/glossary#to_counterparty): \n\n\n\n[to_sandbox_tan](/glossary#to_sandbox_tan): \n\n\n\n[to_sepa](/glossary#to_sepa): \n\n\n\n[to_sepa_credit_transfers](/glossary#to_sepa_credit_transfers): \n\n\n\n[to_simple](/glossary#): to_simple\n\n\n\n[to_transfer_to_account](/glossary#to_transfer_to_account): \n\n\n\n[to_transfer_to_atm](/glossary#to_transfer_to_atm): \n\n\n\n[to_transfer_to_phone](/glossary#to_transfer_to_phone): \n\n\n","example_request_body":{"value":{"currency":"EUR","amount":"0"},"description":"This is a FREE_FORM Transaction Request"},"success_response_body":{"id":"4050046c-63b3-4868-8a22-14b4181d33a6","type":"SANDBOX_TAN","from":{"bank_id":"gh.29.uk","account_id":"8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0"},"details":{"to_sandbox_tan":{"bank_id":"String","account_id":"String"},"to_sepa":{"iban":"String"},"to_counterparty":{"counterparty_id":"9fg8a7e4-6d02-40e3-a129-0b2bf89de8uh"},"to_simple":{"otherBankRoutingScheme":"BIC","otherBankRoutingAddress":"GENODEM1GLS","otherBranchRoutingScheme":"BRANCH-CODE","otherBranchRoutingAddress":"DERBY6","otherAccountRoutingScheme":"IBAN","otherAccountRoutingAddress":"DE91 1000 0000 0123 4567 89","otherAccountSecondaryRoutingScheme":"IBAN","otherAccountSecondaryRoutingAddress":"DE91 1000 0000 0123 4567 89"},"to_transfer_to_phone":{"value":{"currency":"EUR","amount":"0"},"description":"String","message":"String","from":{"mobile_phone_number":"+44 07972 444 876","nickname":"String"},"to":{"mobile_phone_number":"+44 07972 444 876"}},"to_transfer_to_atm":{"value":{"currency":"EUR","amount":"0"},"description":"String","message":"String","from":{"mobile_phone_number":"+44 07972 444 876","nickname":"String"},"to":{"legal_name":"Eveline Tripman","date_of_birth":"20181230","mobile_phone_number":"+44 07972 444 876","kyc_document":{"type":"String","number":"String"}}},"to_transfer_to_account":{"value":{"currency":"EUR","amount":"0"},"description":"String","transfer_type":"String","future_date":"20181230","to":{"name":"String","bank_code":"String","branch_number":"String","account":{"number":"String","iban":"String"}}},"to_sepa_credit_transfers":{"debtorAccount":{"iban":"12345"},"instructedAmount":{"currency":"EUR","amount":"0"},"creditorAccount":{"iban":"54321"},"creditorName":"John Miles"},"value":{"currency":"EUR","amount":"100"},"description":"This an optional field. Maximum length is 2000. It can be any characters here."},"transaction_ids":["902ba3bb-dedd-45e7-9319-2fd3f2cd98a1"],"status":"COMPLETED","start_date":"1100-01-01T00:00:00Z","end_date":"1100-01-01T00:00:00Z","challenges":[{"id":"2fg8a7e4-6d02-40e3-a129-0b2bf89de8ub","user_id":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1","allowed_attempts":3,"challenge_type":"OBP_TRANSACTION_REQUEST_CHALLENGE","link":"/obp/v4.0.0/banks/BANK_ID/accounts/ACCOUNT_ID/VIEW_ID/transaction-request-types/TRANSACTION_REQUEST_TYPE/transaction-requests/TRANSACTION_REQUEST_ID/challenge"}],"charge":{"summary":"Rent the flat","value":{"currency":"EUR","amount":"0"}}},"error_response_bodies":["OBP-20001: User not logged in. Authentication is required!","OBP-30111: Invalid Bank Id. The BANK_ID should only contain 0-9/a-z/A-Z/'-'/'.'/'_', the length should be smaller than 255.","OBP-30110: Invalid Account Id. The ACCOUNT_ID should only contain 0-9/a-z/A-Z/'-'/'.'/'_', the length should be smaller than 255.","OBP-10001: Incorrect json format.","OBP-30001: Bank not found. Please specify a valid value for BANK_ID.","OBP-30003: Account not found. Please specify a valid value for ACCOUNT_ID.","OBP-30018: Bank Account not found. Please specify valid values for BANK_ID and ACCOUNT_ID. ","OBP-40002: Insufficient authorisation to create TransactionRequest. The Transaction Request could not be created because the login user doesn't have access to the view of the from account or the consumer doesn't have the access to the view of the from account or the login user does not have the `CanCreateAnyTransactionRequest` role or the view does not have the permission canaddtransactionrequesttoanyaccount.","OBP-40001: Invalid value for TRANSACTION_REQUEST_TYPE","OBP-10001: Incorrect json format.","OBP-10002: Invalid Number. Could not convert value to a number.","OBP-40008: Can't send a payment with a value of 0 or less.","OBP-40003: Transaction Request Currency must be the same as From Account Currency.","OBP-00003: Transaction Requests is disabled in this API instance.","OBP-50000: Unknown Error.","OBP-20006: User is missing one or more roles: "],"tags":["Transaction-Request","Payment Initiation Service (PIS)"],"typed_request_body":{"type":"object","properties":{"description":{"type":"string"},"value":{"type":"object","properties":{"currency":{"type":"string"},"amount":{"type":"string"}}}}},"typed_success_response_body":{"type":"object","properties":{"type":{"type":"string"},"challenges":{"type":"array","items":{"type":"object","properties":{"challenge_type":{"type":"string"},"link":{"type":"string"},"id":{"type":"string"},"allowed_attempts":{"type":"integer"},"user_id":{"type":"string"}}}},"status":{"type":"string"},"end_date":{"type":"string","format":"date-time"},"charge":{"type":"object","properties":{"summary":{"type":"string"},"value":{"type":"object","properties":{"currency":{"type":"string"},"amount":{"type":"string"}}}}},"transaction_ids":{"type":"array","items":{"type":"string"}},"from":{"type":"object","properties":{"bank_id":{"type":"string"},"account_id":{"type":"string"}}},"details":{"type":"object","properties":{"description":{"type":"string"},"to_sandbox_tan":{"type":"object","properties":{"account_id":{"type":"string"},"bank_id":{"type":"string"}}},"value":{"type":"object","properties":{"currency":{"type":"string"},"amount":{"type":"string"}}},"to_transfer_to_phone":{"type":"object","properties":{"description":{"type":"string"},"message":{"type":"string"},"from":{"type":"object","properties":{"nickname":{"type":"string"},"mobile_phone_number":{"type":"string"}}},"to":{"type":"object","properties":{"mobile_phone_number":{"type":"string"}}},"value":{"type":"object","properties":{"currency":{"type":"string"},"amount":{"type":"string"}}}}},"to_sepa":{"type":"object","properties":{"iban":{"type":"string"}}},"to_simple":{"type":"object","properties":{"otherBankRoutingAddress":{"type":"string"},"otherAccountSecondaryRoutingAddress":{"type":"string"},"otherBranchRoutingScheme":{"type":"string"},"otherAccountRoutingScheme":{"type":"string"},"otherAccountRoutingAddress":{"type":"string"},"otherBankRoutingScheme":{"type":"string"},"otherBranchRoutingAddress":{"type":"string"},"otherAccountSecondaryRoutingScheme":{"type":"string"}}},"to_counterparty":{"type":"object","properties":{"counterparty_id":{"type":"string"}}},"to_transfer_to_account":{"type":"object","properties":{"to":{"type":"object","properties":{"name":{"type":"string"},"account":{"type":"object","properties":{"number":{"type":"string"},"iban":{"type":"string"}}},"bank_code":{"type":"string"},"branch_number":{"type":"string"}}},"transfer_type":{"type":"string"},"description":{"type":"string"},"future_date":{"type":"string"},"value":{"type":"object","properties":{"currency":{"type":"string"},"amount":{"type":"string"}}}}},"to_sepa_credit_transfers":{"type":"object","properties":{"instructedAmount":{"type":"object","properties":{"currency":{"type":"string"},"amount":{"type":"string"}}},"debtorAccount":{"type":"object","properties":{"iban":{"type":"string"}}},"creditorAccount":{"type":"object","properties":{"iban":{"type":"string"}}},"creditorName":{"type":"string"}}},"to_transfer_to_atm":{"type":"object","properties":{"description":{"type":"string"},"message":{"type":"string"},"from":{"type":"object","properties":{"nickname":{"type":"string"},"mobile_phone_number":{"type":"string"}}},"value":{"type":"object","properties":{"currency":{"type":"string"},"amount":{"type":"string"}}},"to":{"type":"object","properties":{"date_of_birth":{"type":"string"},"kyc_document":{"type":"object","properties":{"type":{"type":"string"},"number":{"type":"string"}}},"legal_name":{"type":"string"},"mobile_phone_number":{"type":"string"}}}}}}},"start_date":{"type":"string","format":"date-time"},"id":{"type":"string"}}},"roles":[{"role":"CanCreateAnyTransactionRequest","requires_bank_id":true}],"is_featured":false,"special_instructions":"","specified_url":"/obp/v4.0.0/banks/BANK_ID/accounts/ACCOUNT_ID/VIEW_ID/transaction-request-types/FREE_FORM/transaction-requests","connector_methods":[]},{"operation_id":"OBPv1.4.0-getTransactionRequestTypes","implemented_by":{"version":"OBPv1.4.0","function":"getTransactionRequestTypes"},"request_verb":"GET","request_url":"/obp/v1.4.0/banks/BANK_ID/accounts/ACCOUNT_ID/VIEW_ID/transaction-request-types","summary":"Get Transaction Request Types for Account","description":"Returns the Transaction Request Types that the account specified by ACCOUNT_ID and view specified by VIEW_ID has access to.
\nThese are the ways this API Server can create a Transaction via a Transaction Request
\n(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:
\nFor 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.
\nThis 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.
\nAuthentication is Mandatory
\nURL Parameters:
\nACCOUNT_ID: 8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0
\nBANK_ID: gh.29.uk
\nVIEW_ID: owner
\nJSON response body fields:
\namount: 10.12
\n\ncurrency: EUR
\n\n\nvalue: 5987953
\n","description_markdown":"Returns the Transaction Request Types that the account specified by ACCOUNT_ID and view specified by VIEW_ID has access to.\n\nThese are the ways this API Server can create a Transaction via a Transaction Request\n(as opposed to Transaction Types which include external types too e.g. for Transactions created by core banking etc.)\n\n A Transaction Request Type internally determines:\n\n * the required Transaction Request 'body' i.e. fields that define the 'what' and 'to' of a Transaction Request,\n * the type of security challenge that may be be raised before the Transaction Request proceeds, and\n * the threshold of that challenge.\n\n 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.\n\n 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.\n \n \n\nAuthentication is Mandatory\n\n\n**URL Parameters:**\n\n[ACCOUNT_ID](/glossary#Account.account_id): 8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0\n\n\n\n[BANK_ID](/glossary#Bank.bank_id): gh.29.uk\n\n\n\n[VIEW_ID](/glossary#this_view_id): owner\n\n\n\n\n\n**JSON response body fields:**\n\n\n\n[**amount**](/glossary#): 10.12\n\n\n\n[**charge**](/glossary#charge): \n\n\n\n[**currency**](/glossary#): EUR\n\n\n\n[**summary**](/glossary#summary): \n\n\n\n[**transaction_request_types**](/glossary#transaction_request_types): \n\n\n\n[**value**](/glossary#): 5987953\n\n\n","example_request_body":{"jsonString":"{}"},"success_response_body":{"transaction_request_types":[{"value":"10","charge":{"summary":"The bank fixed charge","value":{"currency":"EUR","amount":"0"}}}]},"error_response_bodies":["OBP-20001: User not logged in. Authentication is required!","OBP-30001: Bank not found. Please specify a valid value for BANK_ID.","OBP-30003: Account not found. Please specify a valid value for ACCOUNT_ID.","Please specify a valid value for CURRENCY of your Bank Account. ","Current user does not have access to the view ","account not found at bank","user does not have access to owner view","OBP-40018: Sorry, Transaction Requests are not enabled in this API instance.","OBP-50000: Unknown Error."],"tags":["Transaction-Request","Payment Initiation Service (PIS)","PSD2"],"typed_request_body":{"type":"object","properties":{"jsonString":{"type":"string"}}},"typed_success_response_body":{"type":"object","properties":{"transaction_request_types":{"type":"array","items":{"type":"object","properties":{"charge":{"type":"object","properties":{"value":{"type":"object","properties":{"currency":{"type":"string"},"amount":{"type":"string"}}},"summary":{"type":"string"}}},"value":{"type":"string"}}}}}},"is_featured":false,"special_instructions":"","specified_url":"/obp/v4.0.0/banks/BANK_ID/accounts/ACCOUNT_ID/VIEW_ID/transaction-request-types","connector_methods":[]},{"operation_id":"OBPv4.0.0-createTransactionRequestAccount","implemented_by":{"version":"OBPv4.0.0","function":"createTransactionRequestAccount"},"request_verb":"POST","request_url":"/obp/v4.0.0/banks/BANK_ID/accounts/ACCOUNT_ID/VIEW_ID/transaction-request-types/ACCOUNT/transaction-requests","summary":"Create Transaction Request (ACCOUNT)","description":"When using ACCOUNT, the payee is set in the request body.
\nMoney goes into the BANK_ID and ACCOUNT_ID specified in the request body.
\nInitiate a Payment via creating a Transaction Request.
\nIn OBP, a transaction request
may or may not result in a transaction
. However, a transaction
only has one possible state: completed.
A Transaction Request
can have one of several states: INITIATED, NEXT_CHALLENGE_PENDING etc.
Transactions
are modeled on items in a bank statement that represent the movement of money.
Transaction Requests
are requests to move money which may or may not succeed and thus result in a Transaction
.
A Transaction Request
might create a security challenge that needs to be answered before the Transaction Request
proceeds.
\nIn case 1 person needs to answer security challenge we have next flow of state of an transaction request
:
\nINITIATED => COMPLETED
\nIn case n persons needs to answer security challenge we have next flow of state of an transaction request
:
\nINITIATED => NEXT_CHALLENGE_PENDING => ... => NEXT_CHALLENGE_PENDING => COMPLETED
The security challenge is bound to a user i.e. in case of right answer and the user is different than expected one the challenge will fail.
\nRule for calculating number of security challenges:
\nIf product Account attribute REQUIRED_CHALLENGE_ANSWERS=N then create N challenges
\n(one for every user that has a View where permission "can_add_transaction_request_to_any_account"=true)
\nIn case REQUIRED_CHALLENGE_ANSWERS is not defined as an account attribute default value is 1.
Transaction Requests contain charge information giving the client the opportunity to proceed or not (as long as the challenge level is appropriate).
\nTransaction Requests can have one of several Transaction Request Types which expect different bodies. The escaped body is returned in the details key of the GET response.
\nThis provides some commonality and one URL for many different payment or transfer types with enough flexibility to validate them differently.
The payer is set in the URL. Money comes out of the BANK_ID and ACCOUNT_ID specified in the URL.
\nIn sandbox mode, TRANSACTION_REQUEST_TYPE is commonly set to ACCOUNT. See getTransactionRequestTypesSupportedByBank for all supported types.
\nIn sandbox mode, if the amount is less than 1000 EUR (any currency, unless it is set differently on this server), the transaction request will create a transaction without a challenge, else the Transaction Request will be set to INITIALISED and a challenge will need to be answered.
\nIf a challenge is created you must answer it using Answer Transaction Request Challenge before the Transaction is created.
\nYou can transfer between different currency accounts. (new in 2.0.0). The currency in body must match the sending account.
\nThe following static FX rates are available in sandbox mode:
\n\nTransaction Requests satisfy PSD2 requirements thus:
\n1) A transaction can be initiated by a third party application.
\n2) The customer is informed of the charge that will incurred.
\n3) The call supports delegated authentication (OAuth)
\nSee this python code for a complete example of this flow.
\nThere is further documentation here
\nAuthentication is Mandatory
\nURL Parameters:
\n\nACCOUNT_ID: 8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0
\nBANK_ID: gh.29.uk
\nVIEW_ID: owner
\nJSON request body fields:
\naccount_id: 8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0
\namount: 10.12
\nbank_id: gh.29.uk
\ncurrency: EUR
\ndescription: This an optional field. Maximum length is 2000. It can be any characters here.
\nto:
\nvalue: 5987953
\nJSON response body fields:
\n\naccount_id: 8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0
\n\namount: 10.12
\nbank_code: CGHZ
\nbank_id: gh.29.uk
\n\n\nchallenges: challenges
\n\ncounterparty_id: 9fg8a7e4-6d02-40e3-a129-0b2bf89de8uh
\n\n\ncurrency: EUR
\ndate_of_birth: 2018-03-09
\n\ndescription: This an optional field. Maximum length is 2000. It can be any characters here.
\n\n\nfrom:
\nfuture_date: 20200127
\niban: DE91 1000 0000 0123 4567 89
\nid: d8839721-ad8f-45dd-9f78-2080414b93f9
\ninstructedAmount: 100
\n\nlegal_name: Eveline Tripman
\nlink:
\nmessage: 123456
\nmobile_phone_number: +49 30 901820
\nname: ACCOUNT_MANAGEMENT_FEE
\n\n\notherAccountRoutingAddress: otherAccountRoutingAddress
\notherAccountRoutingScheme: otherAccountRoutingScheme
\notherAccountSecondaryRoutingAddress: otherAccountSecondaryRoutingAddress
\notherAccountSecondaryRoutingScheme: otherAccountSecondaryRoutingScheme
\notherBankRoutingAddress: otherBankRoutingAddress
\notherBankRoutingScheme: otherBankRoutingScheme
\notherBranchRoutingAddress: otherBranchRoutingAddress
\notherBranchRoutingScheme: otherBranchRoutingScheme
\nstart_date: 2020-01-27
\n\n\nto:
\n\n\ntype:
\nuser_id: 9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1
\nvalue: 5987953
\n\n\n\n\nto_simple: to_simple
\n\n\n\n","description_markdown":"When using ACCOUNT, the payee is set in the request body.\n\nMoney goes into the BANK_ID and ACCOUNT_ID specified in the request body.\n\nInitiate a Payment via creating a Transaction Request.\n\nIn OBP, a `transaction request` may or may not result in a `transaction`. However, a `transaction` only has one possible state: completed.\n\nA `Transaction Request` can have one of several states: INITIATED, NEXT_CHALLENGE_PENDING etc.\n\n`Transactions` are modeled on items in a bank statement that represent the movement of money.\n\n`Transaction Requests` are requests to move money which may or may not succeed and thus result in a `Transaction`.\n\nA `Transaction Request` might create a security challenge that needs to be answered before the `Transaction Request` proceeds.\nIn case 1 person needs to answer security challenge we have next flow of state of an `transaction request`:\n INITIATED => COMPLETED\nIn case n persons needs to answer security challenge we have next flow of state of an `transaction request`:\n INITIATED => NEXT_CHALLENGE_PENDING => ... => NEXT_CHALLENGE_PENDING => COMPLETED\n\nThe security challenge is bound to a user i.e. in case of right answer and the user is different than expected one the challenge will fail.\n\nRule for calculating number of security challenges:\nIf product Account attribute REQUIRED_CHALLENGE_ANSWERS=N then create N challenges\n(one for every user that has a View where permission \"can_add_transaction_request_to_any_account\"=true)\nIn case REQUIRED_CHALLENGE_ANSWERS is not defined as an account attribute default value is 1.\n\nTransaction Requests contain charge information giving the client the opportunity to proceed or not (as long as the challenge level is appropriate).\n\nTransaction Requests can have one of several Transaction Request Types which expect different bodies. The escaped body is returned in the details key of the GET response.\nThis provides some commonality and one URL for many different payment or transfer types with enough flexibility to validate them differently.\n\nThe payer is set in the URL. Money comes out of the BANK_ID and ACCOUNT_ID specified in the URL.\n\nIn sandbox mode, TRANSACTION_REQUEST_TYPE is commonly set to ACCOUNT. See getTransactionRequestTypesSupportedByBank for all supported types.\n\nIn sandbox mode, if the amount is less than 1000 EUR (any currency, unless it is set differently on this server), the transaction request will create a transaction without a challenge, else the Transaction Request will be set to INITIALISED and a challenge will need to be answered.\n\nIf a challenge is created you must answer it using Answer Transaction Request Challenge before the Transaction is created.\n\nYou can transfer between different currency accounts. (new in 2.0.0). The currency in body must match the sending account.\n\nThe following static FX rates are available in sandbox mode:\n\nhttps://apiexplorer-ii-sandbox.openbankproject.com//more?version=OBPv4.0.0&list-all-banks=false&core=&psd2=&obwg=#OBPv2_2_0-getCurrentFxRate\n\n\nTransaction Requests satisfy PSD2 requirements thus:\n\n1) A transaction can be initiated by a third party application.\n\n2) The customer is informed of the charge that will incurred.\n\n3) The call supports delegated authentication (OAuth)\n\nSee [this python code](https://github.com/OpenBankProject/Hello-OBP-DirectLogin-Python/blob/master/hello_payments.py) for a complete example of this flow.\n\nThere is further documentation [here](https://github.com/OpenBankProject/OBP-API/wiki/Transaction-Requests)\n\n\n\n \n\nAuthentication is Mandatory\n\n\n**URL Parameters:**\n\n[ACCOUNT](/glossary#Account): \n\n\n\n[ACCOUNT_ID](/glossary#Account.account_id): 8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0\n\n\n\n[BANK_ID](/glossary#Bank.bank_id): gh.29.uk\n\n\n\n[VIEW_ID](/glossary#this_view_id): owner\n\n\n\n\n\n**JSON request body fields:**\n\n\n\n[**account_id**](/glossary#): 8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0\n\n\n\n[**amount**](/glossary#): 10.12\n\n\n\n[**bank_id**](/glossary#): gh.29.uk\n\n\n\n[**currency**](/glossary#): EUR\n\n\n\n[**description**](/glossary#description): This an optional field. Maximum length is 2000. It can be any characters here.\n\n\n\n[**to**](/glossary#to): \n\n\n\n[**value**](/glossary#): 5987953\n\n\n\n\n\n**JSON response body fields:**\n\n\n\n[**account**](/glossary#Account): \n\n\n\n[**account_id**](/glossary#): 8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0\n\n\n\n[**allowed_attempts**](/glossary#allowed_attempts): 5\n\n\n\n[**amount**](/glossary#): 10.12\n\n\n\n[**bank_code**](/glossary#bank_code): CGHZ\n\n\n\n[**bank_id**](/glossary#): gh.29.uk\n\n\n\n[**branch_number**](/glossary#branch_number): \n\n\n\n[**challenge_type**](/glossary#challenge_type): \n\n\n\n[**challenges**](/glossary#): challenges\n\n\n\n[**charge**](/glossary#charge): \n\n\n\n[**counterparty_id**](/glossary#): 9fg8a7e4-6d02-40e3-a129-0b2bf89de8uh\n\n\n\n[**creditorAccount**](/glossary#creditoraccount): \n\n\n\n[**creditorName**](/glossary#creditorname): \n\n\n\n[**currency**](/glossary#): EUR\n\n\n\n[**date_of_birth**](/glossary#): 2018-03-09\n\n\n\n[**debtorAccount**](/glossary#debtoraccount): \n\n\n\n[**description**](/glossary#description): This an optional field. Maximum length is 2000. It can be any characters here.\n\n\n\n[**details**](/glossary#details): \n\n\n\n[**end_date**](/glossary#end_date): \n\n\n\n[**from**](/glossary#from): \n\n\n\n[**future_date**](/glossary#future_date): 20200127\n\n\n\n[**iban**](/glossary#): DE91 1000 0000 0123 4567 89\n\n\n\n[**id**](/glossary#id): d8839721-ad8f-45dd-9f78-2080414b93f9\n\n\n\n[**instructedAmount**](/glossary#instructedamount): 100\n\n\n\n[**kyc_document**](/glossary#kyc_document): \n\n\n\n[**legal_name**](/glossary#): Eveline Tripman\n\n\n\n[**link**](/glossary#link): \n\n\n\n[**message**](/glossary#message): 123456\n\n\n\n[**mobile_phone_number**](/glossary#mobile_phone_number): +49 30 901820\n\n\n\n[**name**](/glossary#name): ACCOUNT_MANAGEMENT_FEE\n\n\n\n[**nickname**](/glossary#nickname): \n\n\n\n[**number**](/glossary#number): \n\n\n\n[**otherAccountRoutingAddress**](/glossary#): otherAccountRoutingAddress\n\n\n\n[**otherAccountRoutingScheme**](/glossary#): otherAccountRoutingScheme\n\n\n\n[**otherAccountSecondaryRoutingAddress**](/glossary#): otherAccountSecondaryRoutingAddress\n\n\n\n[**otherAccountSecondaryRoutingScheme**](/glossary#): otherAccountSecondaryRoutingScheme\n\n\n\n[**otherBankRoutingAddress**](/glossary#): otherBankRoutingAddress\n\n\n\n[**otherBankRoutingScheme**](/glossary#): otherBankRoutingScheme\n\n\n\n[**otherBranchRoutingAddress**](/glossary#): otherBranchRoutingAddress\n\n\n\n[**otherBranchRoutingScheme**](/glossary#): otherBranchRoutingScheme\n\n\n\n[**start_date**](/glossary#): 2020-01-27\n\n\n\n[**status**](/glossary#status): \n\n\n\n[**summary**](/glossary#summary): \n\n\n\n[**to**](/glossary#to): \n\n\n\n[**transaction_ids**](/glossary#transaction_ids): \n\n\n\n[**transfer_type**](/glossary#transfer_type): \n\n\n\n[**type**](/glossary#type): \n\n\n\n[**user_id**](/glossary#): 9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1\n\n\n\n[**value**](/glossary#): 5987953\n\n\n\n[to_counterparty](/glossary#to_counterparty): \n\n\n\n[to_sandbox_tan](/glossary#to_sandbox_tan): \n\n\n\n[to_sepa](/glossary#to_sepa): \n\n\n\n[to_sepa_credit_transfers](/glossary#to_sepa_credit_transfers): \n\n\n\n[to_simple](/glossary#): to_simple\n\n\n\n[to_transfer_to_account](/glossary#to_transfer_to_account): \n\n\n\n[to_transfer_to_atm](/glossary#to_transfer_to_atm): \n\n\n\n[to_transfer_to_phone](/glossary#to_transfer_to_phone): \n\n\n","example_request_body":{"to":{"bank_id":"gh.29.uk","account_id":"8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0"},"value":{"currency":"EUR","amount":"0"},"description":"this is for work"},"success_response_body":{"id":"4050046c-63b3-4868-8a22-14b4181d33a6","type":"SANDBOX_TAN","from":{"bank_id":"gh.29.uk","account_id":"8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0"},"details":{"to_sandbox_tan":{"bank_id":"String","account_id":"String"},"to_sepa":{"iban":"String"},"to_counterparty":{"counterparty_id":"9fg8a7e4-6d02-40e3-a129-0b2bf89de8uh"},"to_simple":{"otherBankRoutingScheme":"BIC","otherBankRoutingAddress":"GENODEM1GLS","otherBranchRoutingScheme":"BRANCH-CODE","otherBranchRoutingAddress":"DERBY6","otherAccountRoutingScheme":"IBAN","otherAccountRoutingAddress":"DE91 1000 0000 0123 4567 89","otherAccountSecondaryRoutingScheme":"IBAN","otherAccountSecondaryRoutingAddress":"DE91 1000 0000 0123 4567 89"},"to_transfer_to_phone":{"value":{"currency":"EUR","amount":"0"},"description":"String","message":"String","from":{"mobile_phone_number":"+44 07972 444 876","nickname":"String"},"to":{"mobile_phone_number":"+44 07972 444 876"}},"to_transfer_to_atm":{"value":{"currency":"EUR","amount":"0"},"description":"String","message":"String","from":{"mobile_phone_number":"+44 07972 444 876","nickname":"String"},"to":{"legal_name":"Eveline Tripman","date_of_birth":"20181230","mobile_phone_number":"+44 07972 444 876","kyc_document":{"type":"String","number":"String"}}},"to_transfer_to_account":{"value":{"currency":"EUR","amount":"0"},"description":"String","transfer_type":"String","future_date":"20181230","to":{"name":"String","bank_code":"String","branch_number":"String","account":{"number":"String","iban":"String"}}},"to_sepa_credit_transfers":{"debtorAccount":{"iban":"12345"},"instructedAmount":{"currency":"EUR","amount":"0"},"creditorAccount":{"iban":"54321"},"creditorName":"John Miles"},"value":{"currency":"EUR","amount":"100"},"description":"This an optional field. Maximum length is 2000. It can be any characters here."},"transaction_ids":["902ba3bb-dedd-45e7-9319-2fd3f2cd98a1"],"status":"COMPLETED","start_date":"1100-01-01T00:00:00Z","end_date":"1100-01-01T00:00:00Z","challenges":[{"id":"2fg8a7e4-6d02-40e3-a129-0b2bf89de8ub","user_id":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1","allowed_attempts":3,"challenge_type":"OBP_TRANSACTION_REQUEST_CHALLENGE","link":"/obp/v4.0.0/banks/BANK_ID/accounts/ACCOUNT_ID/VIEW_ID/transaction-request-types/TRANSACTION_REQUEST_TYPE/transaction-requests/TRANSACTION_REQUEST_ID/challenge"}],"charge":{"summary":"Rent the flat","value":{"currency":"EUR","amount":"0"}}},"error_response_bodies":["OBP-20001: User not logged in. Authentication is required!","OBP-30111: Invalid Bank Id. The BANK_ID should only contain 0-9/a-z/A-Z/'-'/'.'/'_', the length should be smaller than 255.","OBP-30110: Invalid Account Id. The ACCOUNT_ID should only contain 0-9/a-z/A-Z/'-'/'.'/'_', the length should be smaller than 255.","OBP-10001: Incorrect json format.","OBP-30001: Bank not found. Please specify a valid value for BANK_ID.","OBP-30003: Account not found. Please specify a valid value for ACCOUNT_ID.","OBP-30018: Bank Account not found. Please specify valid values for BANK_ID and ACCOUNT_ID. ","OBP-40002: Insufficient authorisation to create TransactionRequest. The Transaction Request could not be created because the login user doesn't have access to the view of the from account or the consumer doesn't have the access to the view of the from account or the login user does not have the `CanCreateAnyTransactionRequest` role or the view does not have the permission canaddtransactionrequesttoanyaccount.","OBP-40001: Invalid value for TRANSACTION_REQUEST_TYPE","OBP-10001: Incorrect json format.","OBP-10002: Invalid Number. Could not convert value to a number.","OBP-40008: Can't send a payment with a value of 0 or less.","OBP-40003: Transaction Request Currency must be the same as From Account Currency.","OBP-00003: Transaction Requests is disabled in this API instance.","OBP-50000: Unknown Error."],"tags":["Transaction-Request","Payment Initiation Service (PIS)","PSD2"],"typed_request_body":{"type":"object","properties":{"to":{"type":"object","properties":{"bank_id":{"type":"string"},"account_id":{"type":"string"}}},"description":{"type":"string"},"value":{"type":"object","properties":{"currency":{"type":"string"},"amount":{"type":"string"}}}}},"typed_success_response_body":{"type":"object","properties":{"type":{"type":"string"},"challenges":{"type":"array","items":{"type":"object","properties":{"challenge_type":{"type":"string"},"link":{"type":"string"},"id":{"type":"string"},"allowed_attempts":{"type":"integer"},"user_id":{"type":"string"}}}},"status":{"type":"string"},"end_date":{"type":"string","format":"date-time"},"charge":{"type":"object","properties":{"summary":{"type":"string"},"value":{"type":"object","properties":{"currency":{"type":"string"},"amount":{"type":"string"}}}}},"transaction_ids":{"type":"array","items":{"type":"string"}},"from":{"type":"object","properties":{"bank_id":{"type":"string"},"account_id":{"type":"string"}}},"details":{"type":"object","properties":{"description":{"type":"string"},"to_sandbox_tan":{"type":"object","properties":{"account_id":{"type":"string"},"bank_id":{"type":"string"}}},"value":{"type":"object","properties":{"currency":{"type":"string"},"amount":{"type":"string"}}},"to_transfer_to_phone":{"type":"object","properties":{"description":{"type":"string"},"message":{"type":"string"},"from":{"type":"object","properties":{"nickname":{"type":"string"},"mobile_phone_number":{"type":"string"}}},"to":{"type":"object","properties":{"mobile_phone_number":{"type":"string"}}},"value":{"type":"object","properties":{"currency":{"type":"string"},"amount":{"type":"string"}}}}},"to_sepa":{"type":"object","properties":{"iban":{"type":"string"}}},"to_simple":{"type":"object","properties":{"otherBankRoutingAddress":{"type":"string"},"otherAccountSecondaryRoutingAddress":{"type":"string"},"otherBranchRoutingScheme":{"type":"string"},"otherAccountRoutingScheme":{"type":"string"},"otherAccountRoutingAddress":{"type":"string"},"otherBankRoutingScheme":{"type":"string"},"otherBranchRoutingAddress":{"type":"string"},"otherAccountSecondaryRoutingScheme":{"type":"string"}}},"to_counterparty":{"type":"object","properties":{"counterparty_id":{"type":"string"}}},"to_transfer_to_account":{"type":"object","properties":{"to":{"type":"object","properties":{"name":{"type":"string"},"account":{"type":"object","properties":{"number":{"type":"string"},"iban":{"type":"string"}}},"bank_code":{"type":"string"},"branch_number":{"type":"string"}}},"transfer_type":{"type":"string"},"description":{"type":"string"},"future_date":{"type":"string"},"value":{"type":"object","properties":{"currency":{"type":"string"},"amount":{"type":"string"}}}}},"to_sepa_credit_transfers":{"type":"object","properties":{"instructedAmount":{"type":"object","properties":{"currency":{"type":"string"},"amount":{"type":"string"}}},"debtorAccount":{"type":"object","properties":{"iban":{"type":"string"}}},"creditorAccount":{"type":"object","properties":{"iban":{"type":"string"}}},"creditorName":{"type":"string"}}},"to_transfer_to_atm":{"type":"object","properties":{"description":{"type":"string"},"message":{"type":"string"},"from":{"type":"object","properties":{"nickname":{"type":"string"},"mobile_phone_number":{"type":"string"}}},"value":{"type":"object","properties":{"currency":{"type":"string"},"amount":{"type":"string"}}},"to":{"type":"object","properties":{"date_of_birth":{"type":"string"},"kyc_document":{"type":"object","properties":{"type":{"type":"string"},"number":{"type":"string"}}},"legal_name":{"type":"string"},"mobile_phone_number":{"type":"string"}}}}}}},"start_date":{"type":"string","format":"date-time"},"id":{"type":"string"}}},"is_featured":false,"special_instructions":"","specified_url":"/obp/v4.0.0/banks/BANK_ID/accounts/ACCOUNT_ID/VIEW_ID/transaction-request-types/ACCOUNT/transaction-requests","connector_methods":[]},{"operation_id":"OBPv4.0.0-deleteTransactionRequestAttributeDefinition","implemented_by":{"version":"OBPv4.0.0","function":"deleteTransactionRequestAttributeDefinition"},"request_verb":"DELETE","request_url":"/obp/v4.0.0/banks/BANK_ID/attribute-definitions/ATTRIBUTE_DEFINITION_ID/transaction-request","summary":"Delete Transaction Request Attribute Definition","description":"Delete Transaction Request Attribute Definition by ATTRIBUTE_DEFINITION_ID
\nAuthentication is Mandatory
\nURL Parameters:
\n\nBANK_ID: gh.29.uk
\nJSON response body fields:
\n","description_markdown":"Delete Transaction Request Attribute Definition by ATTRIBUTE_DEFINITION_ID\n\nAuthentication is Mandatory\n\n\n**URL Parameters:**\n\n[ATTRIBUTE_DEFINITION_ID](/glossary#attribute_definition_id): \n\n\n\n[BANK_ID](/glossary#Bank.bank_id): gh.29.uk\n\n\n\n\n\n**JSON response body fields:**\n\n\n","success_response_body":true,"error_response_bodies":["OBP-20001: User not logged in. Authentication is required!","OBP-30001: Bank not found. Please specify a valid value for BANK_ID.","OBP-50000: Unknown Error.","OBP-20006: User is missing one or more roles: "],"tags":["Transaction-Request"],"typed_success_response_body":{"type":"object","properties":{"value":{"type":"boolean"}}},"roles":[{"role":"CanDeleteTransactionRequestAttributeDefinitionAtOneBank","requires_bank_id":true}],"is_featured":false,"special_instructions":"","specified_url":"/obp/v4.0.0/banks/BANK_ID/attribute-definitions/ATTRIBUTE_DEFINITION_ID/transaction-request","connector_methods":[]},{"operation_id":"OBPv4.0.0-getTransactionRequestAttributes","implemented_by":{"version":"OBPv4.0.0","function":"getTransactionRequestAttributes"},"request_verb":"GET","request_url":"/obp/v4.0.0/banks/BANK_ID/accounts/ACCOUNT_ID/transaction-requests/TRANSACTION_REQUEST_ID/attributes","summary":"Get Transaction Request Attributes","description":"Get Transaction Request Attributes
\nAuthentication is Mandatory
\nURL Parameters:
\nACCOUNT_ID: 8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0
\nBANK_ID: gh.29.uk
\nTRANSACTION_REQUEST_ID: 8138a7e4-6d02-40e3-a129-0b2bf89de9f1
\nJSON response body fields:
\nname: ACCOUNT_MANAGEMENT_FEE
\ntransaction_request_attribute_id: 7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh
\ntransaction_request_attributes: transaction_request_attributes
\ntype:
\nvalue: 5987953
\n","description_markdown":"Get Transaction Request Attributes\n\nAuthentication is Mandatory\n\n\n**URL Parameters:**\n\n[ACCOUNT_ID](/glossary#Account.account_id): 8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0\n\n\n\n[BANK_ID](/glossary#Bank.bank_id): gh.29.uk\n\n\n\n[TRANSACTION_REQUEST_ID](/glossary#): 8138a7e4-6d02-40e3-a129-0b2bf89de9f1\n\n\n\n\n\n**JSON response body fields:**\n\n\n\n[**name**](/glossary#name): ACCOUNT_MANAGEMENT_FEE\n\n\n\n[**transaction_request_attribute_id**](/glossary#): 7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh\n\n\n\n[**transaction_request_attributes**](/glossary#): transaction_request_attributes\n\n\n\n[**type**](/glossary#type): \n\n\n\n[**value**](/glossary#): 5987953\n\n\n","success_response_body":{"transaction_request_attributes":[{"transaction_request_attribute_id":"7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh","name":"HOUSE_RENT","type":"DATE_WITH_DAY","value":"123456789"}]},"error_response_bodies":["OBP-20001: User not logged in. Authentication is required!","OBP-30001: Bank not found. Please specify a valid value for BANK_ID.","OBP-30018: Bank Account not found. Please specify valid values for BANK_ID and ACCOUNT_ID. ","OBP-10001: Incorrect json format.","OBP-50000: Unknown Error.","OBP-20006: User is missing one or more roles: "],"tags":["Transaction-Request"],"typed_success_response_body":{"type":"object","properties":{"transaction_request_attributes":{"type":"array","items":{"type":"object","properties":{"name":{"type":"string"},"type":{"type":"string"},"transaction_request_attribute_id":{"type":"string"},"value":{"type":"string"}}}}}},"roles":[{"role":"CanGetTransactionRequestAttributesAtOneBank","requires_bank_id":true}],"is_featured":false,"special_instructions":"","specified_url":"/obp/v4.0.0/banks/BANK_ID/accounts/ACCOUNT_ID/transaction-requests/TRANSACTION_REQUEST_ID/attributes","connector_methods":[]},{"operation_id":"OBPv4.0.0-createTransactionRequestCounterparty","implemented_by":{"version":"OBPv4.0.0","function":"createTransactionRequestCounterparty"},"request_verb":"POST","request_url":"/obp/v4.0.0/banks/BANK_ID/accounts/ACCOUNT_ID/VIEW_ID/transaction-request-types/COUNTERPARTY/transaction-requests","summary":"Create Transaction Request (COUNTERPARTY)","description":"Special instructions for COUNTERPARTY:
\nWhen using a COUNTERPARTY to create a Transaction Request, specificy the counterparty_id in the body of the request.
\nThe routing details of the counterparty will be forwarded for the transfer.
Initiate a Payment via creating a Transaction Request.
\nIn OBP, a transaction request
may or may not result in a transaction
. However, a transaction
only has one possible state: completed.
A Transaction Request
can have one of several states: INITIATED, NEXT_CHALLENGE_PENDING etc.
Transactions
are modeled on items in a bank statement that represent the movement of money.
Transaction Requests
are requests to move money which may or may not succeed and thus result in a Transaction
.
A Transaction Request
might create a security challenge that needs to be answered before the Transaction Request
proceeds.
\nIn case 1 person needs to answer security challenge we have next flow of state of an transaction request
:
\nINITIATED => COMPLETED
\nIn case n persons needs to answer security challenge we have next flow of state of an transaction request
:
\nINITIATED => NEXT_CHALLENGE_PENDING => ... => NEXT_CHALLENGE_PENDING => COMPLETED
The security challenge is bound to a user i.e. in case of right answer and the user is different than expected one the challenge will fail.
\nRule for calculating number of security challenges:
\nIf product Account attribute REQUIRED_CHALLENGE_ANSWERS=N then create N challenges
\n(one for every user that has a View where permission "can_add_transaction_request_to_any_account"=true)
\nIn case REQUIRED_CHALLENGE_ANSWERS is not defined as an account attribute default value is 1.
Transaction Requests contain charge information giving the client the opportunity to proceed or not (as long as the challenge level is appropriate).
\nTransaction Requests can have one of several Transaction Request Types which expect different bodies. The escaped body is returned in the details key of the GET response.
\nThis provides some commonality and one URL for many different payment or transfer types with enough flexibility to validate them differently.
The payer is set in the URL. Money comes out of the BANK_ID and ACCOUNT_ID specified in the URL.
\nIn sandbox mode, TRANSACTION_REQUEST_TYPE is commonly set to ACCOUNT. See getTransactionRequestTypesSupportedByBank for all supported types.
\nIn sandbox mode, if the amount is less than 1000 EUR (any currency, unless it is set differently on this server), the transaction request will create a transaction without a challenge, else the Transaction Request will be set to INITIALISED and a challenge will need to be answered.
\nIf a challenge is created you must answer it using Answer Transaction Request Challenge before the Transaction is created.
\nYou can transfer between different currency accounts. (new in 2.0.0). The currency in body must match the sending account.
\nThe following static FX rates are available in sandbox mode:
\n\nTransaction Requests satisfy PSD2 requirements thus:
\n1) A transaction can be initiated by a third party application.
\n2) The customer is informed of the charge that will incurred.
\n3) The call supports delegated authentication (OAuth)
\nSee this python code for a complete example of this flow.
\nThere is further documentation here
\nAuthentication is Mandatory
\nURL Parameters:
\nACCOUNT_ID: 8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0
\nBANK_ID: gh.29.uk
\n\nVIEW_ID: owner
\nJSON request body fields:
\namount: 10.12
\ncharge_policy: SHARED
\ncounterparty_id: 9fg8a7e4-6d02-40e3-a129-0b2bf89de8uh
\ncurrency: EUR
\ndescription: This an optional field. Maximum length is 2000. It can be any characters here.
\nto:
\nvalue: 5987953
\nfuture_date: 20200127
\nJSON response body fields:
\n\naccount_id: 8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0
\n\namount: 10.12
\nbank_code: CGHZ
\nbank_id: gh.29.uk
\n\n\nchallenges: challenges
\n\ncounterparty_id: 9fg8a7e4-6d02-40e3-a129-0b2bf89de8uh
\n\n\ncurrency: EUR
\ndate_of_birth: 2018-03-09
\n\ndescription: This an optional field. Maximum length is 2000. It can be any characters here.
\n\n\nfrom:
\nfuture_date: 20200127
\niban: DE91 1000 0000 0123 4567 89
\nid: d8839721-ad8f-45dd-9f78-2080414b93f9
\ninstructedAmount: 100
\n\nlegal_name: Eveline Tripman
\nlink:
\nmessage: 123456
\nmobile_phone_number: +49 30 901820
\nname: ACCOUNT_MANAGEMENT_FEE
\n\n\notherAccountRoutingAddress: otherAccountRoutingAddress
\notherAccountRoutingScheme: otherAccountRoutingScheme
\notherAccountSecondaryRoutingAddress: otherAccountSecondaryRoutingAddress
\notherAccountSecondaryRoutingScheme: otherAccountSecondaryRoutingScheme
\notherBankRoutingAddress: otherBankRoutingAddress
\notherBankRoutingScheme: otherBankRoutingScheme
\notherBranchRoutingAddress: otherBranchRoutingAddress
\notherBranchRoutingScheme: otherBranchRoutingScheme
\nstart_date: 2020-01-27
\n\n\nto:
\n\n\ntype:
\nuser_id: 9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1
\nvalue: 5987953
\n\n\n\n\nto_simple: to_simple
\n\n\n\n","description_markdown":"Special instructions for COUNTERPARTY:\n\nWhen using a COUNTERPARTY to create a Transaction Request, specificy the counterparty_id in the body of the request.\nThe routing details of the counterparty will be forwarded for the transfer.\n\nInitiate a Payment via creating a Transaction Request.\n\nIn OBP, a `transaction request` may or may not result in a `transaction`. However, a `transaction` only has one possible state: completed.\n\nA `Transaction Request` can have one of several states: INITIATED, NEXT_CHALLENGE_PENDING etc.\n\n`Transactions` are modeled on items in a bank statement that represent the movement of money.\n\n`Transaction Requests` are requests to move money which may or may not succeed and thus result in a `Transaction`.\n\nA `Transaction Request` might create a security challenge that needs to be answered before the `Transaction Request` proceeds.\nIn case 1 person needs to answer security challenge we have next flow of state of an `transaction request`:\n INITIATED => COMPLETED\nIn case n persons needs to answer security challenge we have next flow of state of an `transaction request`:\n INITIATED => NEXT_CHALLENGE_PENDING => ... => NEXT_CHALLENGE_PENDING => COMPLETED\n\nThe security challenge is bound to a user i.e. in case of right answer and the user is different than expected one the challenge will fail.\n\nRule for calculating number of security challenges:\nIf product Account attribute REQUIRED_CHALLENGE_ANSWERS=N then create N challenges\n(one for every user that has a View where permission \"can_add_transaction_request_to_any_account\"=true)\nIn case REQUIRED_CHALLENGE_ANSWERS is not defined as an account attribute default value is 1.\n\nTransaction Requests contain charge information giving the client the opportunity to proceed or not (as long as the challenge level is appropriate).\n\nTransaction Requests can have one of several Transaction Request Types which expect different bodies. The escaped body is returned in the details key of the GET response.\nThis provides some commonality and one URL for many different payment or transfer types with enough flexibility to validate them differently.\n\nThe payer is set in the URL. Money comes out of the BANK_ID and ACCOUNT_ID specified in the URL.\n\nIn sandbox mode, TRANSACTION_REQUEST_TYPE is commonly set to ACCOUNT. See getTransactionRequestTypesSupportedByBank for all supported types.\n\nIn sandbox mode, if the amount is less than 1000 EUR (any currency, unless it is set differently on this server), the transaction request will create a transaction without a challenge, else the Transaction Request will be set to INITIALISED and a challenge will need to be answered.\n\nIf a challenge is created you must answer it using Answer Transaction Request Challenge before the Transaction is created.\n\nYou can transfer between different currency accounts. (new in 2.0.0). The currency in body must match the sending account.\n\nThe following static FX rates are available in sandbox mode:\n\nhttps://apiexplorer-ii-sandbox.openbankproject.com//more?version=OBPv4.0.0&list-all-banks=false&core=&psd2=&obwg=#OBPv2_2_0-getCurrentFxRate\n\n\nTransaction Requests satisfy PSD2 requirements thus:\n\n1) A transaction can be initiated by a third party application.\n\n2) The customer is informed of the charge that will incurred.\n\n3) The call supports delegated authentication (OAuth)\n\nSee [this python code](https://github.com/OpenBankProject/Hello-OBP-DirectLogin-Python/blob/master/hello_payments.py) for a complete example of this flow.\n\nThere is further documentation [here](https://github.com/OpenBankProject/OBP-API/wiki/Transaction-Requests)\n\n\n\n \n\nAuthentication is Mandatory\n\n\n**URL Parameters:**\n\n[ACCOUNT_ID](/glossary#Account.account_id): 8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0\n\n\n\n[BANK_ID](/glossary#Bank.bank_id): gh.29.uk\n\n\n\n[COUNTERPARTY](/glossary#counterparty): \n\n\n\n[VIEW_ID](/glossary#this_view_id): owner\n\n\n\n\n\n**JSON request body fields:**\n\n\n\n[**amount**](/glossary#): 10.12\n\n\n\n[**charge_policy**](/glossary#): SHARED\n\n\n\n[**counterparty_id**](/glossary#): 9fg8a7e4-6d02-40e3-a129-0b2bf89de8uh\n\n\n\n[**currency**](/glossary#): EUR\n\n\n\n[**description**](/glossary#description): This an optional field. Maximum length is 2000. It can be any characters here.\n\n\n\n[**to**](/glossary#to): \n\n\n\n[**value**](/glossary#): 5987953\n\n\n\n[future_date](/glossary#future_date): 20200127\n\n\n\n\n\n**JSON response body fields:**\n\n\n\n[**account**](/glossary#Account): \n\n\n\n[**account_id**](/glossary#): 8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0\n\n\n\n[**allowed_attempts**](/glossary#allowed_attempts): 5\n\n\n\n[**amount**](/glossary#): 10.12\n\n\n\n[**bank_code**](/glossary#bank_code): CGHZ\n\n\n\n[**bank_id**](/glossary#): gh.29.uk\n\n\n\n[**branch_number**](/glossary#branch_number): \n\n\n\n[**challenge_type**](/glossary#challenge_type): \n\n\n\n[**challenges**](/glossary#): challenges\n\n\n\n[**charge**](/glossary#charge): \n\n\n\n[**counterparty_id**](/glossary#): 9fg8a7e4-6d02-40e3-a129-0b2bf89de8uh\n\n\n\n[**creditorAccount**](/glossary#creditoraccount): \n\n\n\n[**creditorName**](/glossary#creditorname): \n\n\n\n[**currency**](/glossary#): EUR\n\n\n\n[**date_of_birth**](/glossary#): 2018-03-09\n\n\n\n[**debtorAccount**](/glossary#debtoraccount): \n\n\n\n[**description**](/glossary#description): This an optional field. Maximum length is 2000. It can be any characters here.\n\n\n\n[**details**](/glossary#details): \n\n\n\n[**end_date**](/glossary#end_date): \n\n\n\n[**from**](/glossary#from): \n\n\n\n[**future_date**](/glossary#future_date): 20200127\n\n\n\n[**iban**](/glossary#): DE91 1000 0000 0123 4567 89\n\n\n\n[**id**](/glossary#id): d8839721-ad8f-45dd-9f78-2080414b93f9\n\n\n\n[**instructedAmount**](/glossary#instructedamount): 100\n\n\n\n[**kyc_document**](/glossary#kyc_document): \n\n\n\n[**legal_name**](/glossary#): Eveline Tripman\n\n\n\n[**link**](/glossary#link): \n\n\n\n[**message**](/glossary#message): 123456\n\n\n\n[**mobile_phone_number**](/glossary#mobile_phone_number): +49 30 901820\n\n\n\n[**name**](/glossary#name): ACCOUNT_MANAGEMENT_FEE\n\n\n\n[**nickname**](/glossary#nickname): \n\n\n\n[**number**](/glossary#number): \n\n\n\n[**otherAccountRoutingAddress**](/glossary#): otherAccountRoutingAddress\n\n\n\n[**otherAccountRoutingScheme**](/glossary#): otherAccountRoutingScheme\n\n\n\n[**otherAccountSecondaryRoutingAddress**](/glossary#): otherAccountSecondaryRoutingAddress\n\n\n\n[**otherAccountSecondaryRoutingScheme**](/glossary#): otherAccountSecondaryRoutingScheme\n\n\n\n[**otherBankRoutingAddress**](/glossary#): otherBankRoutingAddress\n\n\n\n[**otherBankRoutingScheme**](/glossary#): otherBankRoutingScheme\n\n\n\n[**otherBranchRoutingAddress**](/glossary#): otherBranchRoutingAddress\n\n\n\n[**otherBranchRoutingScheme**](/glossary#): otherBranchRoutingScheme\n\n\n\n[**start_date**](/glossary#): 2020-01-27\n\n\n\n[**status**](/glossary#status): \n\n\n\n[**summary**](/glossary#summary): \n\n\n\n[**to**](/glossary#to): \n\n\n\n[**transaction_ids**](/glossary#transaction_ids): \n\n\n\n[**transfer_type**](/glossary#transfer_type): \n\n\n\n[**type**](/glossary#type): \n\n\n\n[**user_id**](/glossary#): 9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1\n\n\n\n[**value**](/glossary#): 5987953\n\n\n\n[to_counterparty](/glossary#to_counterparty): \n\n\n\n[to_sandbox_tan](/glossary#to_sandbox_tan): \n\n\n\n[to_sepa](/glossary#to_sepa): \n\n\n\n[to_sepa_credit_transfers](/glossary#to_sepa_credit_transfers): \n\n\n\n[to_simple](/glossary#): to_simple\n\n\n\n[to_transfer_to_account](/glossary#to_transfer_to_account): \n\n\n\n[to_transfer_to_atm](/glossary#to_transfer_to_atm): \n\n\n\n[to_transfer_to_phone](/glossary#to_transfer_to_phone): \n\n\n","example_request_body":{"to":{"counterparty_id":"9fg8a7e4-6d02-40e3-a129-0b2bf89de8uh"},"value":{"currency":"EUR","amount":"0"},"description":"A description for the transaction to the counterparty","charge_policy":"SHARED","future_date":"20200127"},"success_response_body":{"id":"4050046c-63b3-4868-8a22-14b4181d33a6","type":"SANDBOX_TAN","from":{"bank_id":"gh.29.uk","account_id":"8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0"},"details":{"to_sandbox_tan":{"bank_id":"String","account_id":"String"},"to_sepa":{"iban":"String"},"to_counterparty":{"counterparty_id":"9fg8a7e4-6d02-40e3-a129-0b2bf89de8uh"},"to_simple":{"otherBankRoutingScheme":"BIC","otherBankRoutingAddress":"GENODEM1GLS","otherBranchRoutingScheme":"BRANCH-CODE","otherBranchRoutingAddress":"DERBY6","otherAccountRoutingScheme":"IBAN","otherAccountRoutingAddress":"DE91 1000 0000 0123 4567 89","otherAccountSecondaryRoutingScheme":"IBAN","otherAccountSecondaryRoutingAddress":"DE91 1000 0000 0123 4567 89"},"to_transfer_to_phone":{"value":{"currency":"EUR","amount":"0"},"description":"String","message":"String","from":{"mobile_phone_number":"+44 07972 444 876","nickname":"String"},"to":{"mobile_phone_number":"+44 07972 444 876"}},"to_transfer_to_atm":{"value":{"currency":"EUR","amount":"0"},"description":"String","message":"String","from":{"mobile_phone_number":"+44 07972 444 876","nickname":"String"},"to":{"legal_name":"Eveline Tripman","date_of_birth":"20181230","mobile_phone_number":"+44 07972 444 876","kyc_document":{"type":"String","number":"String"}}},"to_transfer_to_account":{"value":{"currency":"EUR","amount":"0"},"description":"String","transfer_type":"String","future_date":"20181230","to":{"name":"String","bank_code":"String","branch_number":"String","account":{"number":"String","iban":"String"}}},"to_sepa_credit_transfers":{"debtorAccount":{"iban":"12345"},"instructedAmount":{"currency":"EUR","amount":"0"},"creditorAccount":{"iban":"54321"},"creditorName":"John Miles"},"value":{"currency":"EUR","amount":"100"},"description":"This an optional field. Maximum length is 2000. It can be any characters here."},"transaction_ids":["902ba3bb-dedd-45e7-9319-2fd3f2cd98a1"],"status":"COMPLETED","start_date":"1100-01-01T00:00:00Z","end_date":"1100-01-01T00:00:00Z","challenges":[{"id":"2fg8a7e4-6d02-40e3-a129-0b2bf89de8ub","user_id":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1","allowed_attempts":3,"challenge_type":"OBP_TRANSACTION_REQUEST_CHALLENGE","link":"/obp/v4.0.0/banks/BANK_ID/accounts/ACCOUNT_ID/VIEW_ID/transaction-request-types/TRANSACTION_REQUEST_TYPE/transaction-requests/TRANSACTION_REQUEST_ID/challenge"}],"charge":{"summary":"Rent the flat","value":{"currency":"EUR","amount":"0"}}},"error_response_bodies":["OBP-20001: User not logged in. Authentication is required!","OBP-30111: Invalid Bank Id. The BANK_ID should only contain 0-9/a-z/A-Z/'-'/'.'/'_', the length should be smaller than 255.","OBP-30110: Invalid Account Id. The ACCOUNT_ID should only contain 0-9/a-z/A-Z/'-'/'.'/'_', the length should be smaller than 255.","OBP-10001: Incorrect json format.","OBP-30001: Bank not found. Please specify a valid value for BANK_ID.","OBP-30003: Account not found. Please specify a valid value for ACCOUNT_ID.","OBP-30018: Bank Account not found. Please specify valid values for BANK_ID and ACCOUNT_ID. ","OBP-40002: Insufficient authorisation to create TransactionRequest. The Transaction Request could not be created because the login user doesn't have access to the view of the from account or the consumer doesn't have the access to the view of the from account or the login user does not have the `CanCreateAnyTransactionRequest` role or the view does not have the permission canaddtransactionrequesttoanyaccount.","OBP-40001: Invalid value for TRANSACTION_REQUEST_TYPE","OBP-10001: Incorrect json format.","OBP-10002: Invalid Number. Could not convert value to a number.","OBP-40008: Can't send a payment with a value of 0 or less.","OBP-40003: Transaction Request Currency must be the same as From Account Currency.","OBP-00003: Transaction Requests is disabled in this API instance.","OBP-50000: Unknown Error."],"tags":["Transaction-Request","Payment Initiation Service (PIS)","PSD2"],"typed_request_body":{"type":"object","properties":{"description":{"type":"string"},"future_date":{"type":"string"},"value":{"type":"object","properties":{"currency":{"type":"string"},"amount":{"type":"string"}}},"charge_policy":{"type":"string"},"to":{"type":"object","properties":{"counterparty_id":{"type":"string"}}}}},"typed_success_response_body":{"type":"object","properties":{"type":{"type":"string"},"challenges":{"type":"array","items":{"type":"object","properties":{"challenge_type":{"type":"string"},"link":{"type":"string"},"id":{"type":"string"},"allowed_attempts":{"type":"integer"},"user_id":{"type":"string"}}}},"status":{"type":"string"},"end_date":{"type":"string","format":"date-time"},"charge":{"type":"object","properties":{"summary":{"type":"string"},"value":{"type":"object","properties":{"currency":{"type":"string"},"amount":{"type":"string"}}}}},"transaction_ids":{"type":"array","items":{"type":"string"}},"from":{"type":"object","properties":{"bank_id":{"type":"string"},"account_id":{"type":"string"}}},"details":{"type":"object","properties":{"description":{"type":"string"},"to_sandbox_tan":{"type":"object","properties":{"account_id":{"type":"string"},"bank_id":{"type":"string"}}},"value":{"type":"object","properties":{"currency":{"type":"string"},"amount":{"type":"string"}}},"to_transfer_to_phone":{"type":"object","properties":{"description":{"type":"string"},"message":{"type":"string"},"from":{"type":"object","properties":{"nickname":{"type":"string"},"mobile_phone_number":{"type":"string"}}},"to":{"type":"object","properties":{"mobile_phone_number":{"type":"string"}}},"value":{"type":"object","properties":{"currency":{"type":"string"},"amount":{"type":"string"}}}}},"to_sepa":{"type":"object","properties":{"iban":{"type":"string"}}},"to_simple":{"type":"object","properties":{"otherBankRoutingAddress":{"type":"string"},"otherAccountSecondaryRoutingAddress":{"type":"string"},"otherBranchRoutingScheme":{"type":"string"},"otherAccountRoutingScheme":{"type":"string"},"otherAccountRoutingAddress":{"type":"string"},"otherBankRoutingScheme":{"type":"string"},"otherBranchRoutingAddress":{"type":"string"},"otherAccountSecondaryRoutingScheme":{"type":"string"}}},"to_counterparty":{"type":"object","properties":{"counterparty_id":{"type":"string"}}},"to_transfer_to_account":{"type":"object","properties":{"to":{"type":"object","properties":{"name":{"type":"string"},"account":{"type":"object","properties":{"number":{"type":"string"},"iban":{"type":"string"}}},"bank_code":{"type":"string"},"branch_number":{"type":"string"}}},"transfer_type":{"type":"string"},"description":{"type":"string"},"future_date":{"type":"string"},"value":{"type":"object","properties":{"currency":{"type":"string"},"amount":{"type":"string"}}}}},"to_sepa_credit_transfers":{"type":"object","properties":{"instructedAmount":{"type":"object","properties":{"currency":{"type":"string"},"amount":{"type":"string"}}},"debtorAccount":{"type":"object","properties":{"iban":{"type":"string"}}},"creditorAccount":{"type":"object","properties":{"iban":{"type":"string"}}},"creditorName":{"type":"string"}}},"to_transfer_to_atm":{"type":"object","properties":{"description":{"type":"string"},"message":{"type":"string"},"from":{"type":"object","properties":{"nickname":{"type":"string"},"mobile_phone_number":{"type":"string"}}},"value":{"type":"object","properties":{"currency":{"type":"string"},"amount":{"type":"string"}}},"to":{"type":"object","properties":{"date_of_birth":{"type":"string"},"kyc_document":{"type":"object","properties":{"type":{"type":"string"},"number":{"type":"string"}}},"legal_name":{"type":"string"},"mobile_phone_number":{"type":"string"}}}}}}},"start_date":{"type":"string","format":"date-time"},"id":{"type":"string"}}},"is_featured":false,"special_instructions":"","specified_url":"/obp/v4.0.0/banks/BANK_ID/accounts/ACCOUNT_ID/VIEW_ID/transaction-request-types/COUNTERPARTY/transaction-requests","connector_methods":[]},{"operation_id":"OBPv3.1.0-saveHistoricalTransaction","implemented_by":{"version":"OBPv3.1.0","function":"saveHistoricalTransaction"},"request_verb":"POST","request_url":"/obp/v3.1.0/management/historical/transactions ","summary":"Save Historical Transactions ","description":"Import the historical transactions.
\nThe fields bank_id, account_id, counterparty_id in the json body are all optional ones.
\nIt support transfer money from account to account, account to counterparty and counterparty to counterparty
\nBoth bank_id + account_id and counterparty_id can identify the account, so OBP only need one of them to make the payment.
\nSo:
\nWhen you need the account to account, just omit counterparty_id field.eg:
\n{
\n"from": {
\n"bank_id": "gh.29.uk",
\n"account_id": "1ca8a7e4-6d02-48e3-a029-0b2bf89de9f0",
\n},
\n"to": {
\n"bank_id": "gh.29.uk",
\n"account_id": "2ca8a7e4-6d02-48e3-a029-0b2bf89de9f0",
\n},
\n"value": {
\n"currency": "GBP",
\n"amount": "10"
\n},
\n"description": "this is for work",
\n"posted": "2017-09-19T02:31:05Z",
\n"completed": "2017-09-19T02:31:05Z",
\n"type": "SANDBOX_TAN",
\n"charge_policy": "SHARED"
\n}
When you need the counterparty to counterparty, need to omit bank_id and account_id field.eg:
\n{
\n"from": {
\n"counterparty_id": "f6392b7d-4218-45ea-b9a7-eaa71c0202f9"
\n},
\n"to": {
\n"counterparty_id": "26392b7d-4218-45ea-b9a7-eaa71c0202f9"
\n},
\n"value": {
\n"currency": "GBP",
\n"amount": "10"
\n},
\n"description": "this is for work",
\n"posted": "2017-09-19T02:31:05Z",
\n"completed": "2017-09-19T02:31:05Z",
\n"type": "SANDBOX_TAN",
\n"charge_policy": "SHARED"
\n}
or, you can counterparty to account
\n{
\n"from": {
\n"counterparty_id": "f6392b7d-4218-45ea-b9a7-eaa71c0202f9"
\n},
\n"to": {
\n"bank_id": "gh.29.uk",
\n"account_id": "8ca8a7e4-6d02-48e3-a029-0b2bf89de9f0",
\n},
\n"value": {
\n"currency": "GBP",
\n"amount": "10"
\n},
\n"description": "this is for work",
\n"posted": "2017-09-19T02:31:05Z",
\n"completed": "2017-09-19T02:31:05Z",
\n"type": "SANDBOX_TAN",
\n"charge_policy": "SHARED"
\n}
This call is experimental.
\nAuthentication is Mandatory
\nJSON request body fields:
\namount: 10.12
\ncharge_policy: SHARED
\ncompleted: 2020-01-27
\ncurrency: EUR
\ndescription: This an optional field. Maximum length is 2000. It can be any characters here.
\nfrom:
\nposted: 2020-01-27
\nto:
\ntype:
\nvalue: 5987953
\naccount_id: 8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0
\nbank_id: gh.29.uk
\ncounterparty_id: 9fg8a7e4-6d02-40e3-a129-0b2bf89de8uh
\nJSON response body fields:
\namount: 10.12
\ncharge_policy: SHARED
\ncompleted: 2020-01-27
\ncurrency: EUR
\ndescription: This an optional field. Maximum length is 2000. It can be any characters here.
\nfrom:
\nposted: 2020-01-27
\nto:
\ntransaction_id: 2fg8a7e4-6d02-40e3-a129-0b2bf89de8ub
\ntransaction_request_type: SEPA
\nvalue: 5987953
\naccount_id: 8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0
\nbank_id: gh.29.uk
\ncounterparty_id: 9fg8a7e4-6d02-40e3-a129-0b2bf89de8uh
\n","description_markdown":"Import the historical transactions.\n\nThe fields bank_id, account_id, counterparty_id in the json body are all optional ones.\nIt support transfer money from account to account, account to counterparty and counterparty to counterparty\nBoth bank_id + account_id and counterparty_id can identify the account, so OBP only need one of them to make the payment.\nSo: \nWhen you need the account to account, just omit counterparty_id field.eg:\n{\n \"from\": {\n \"bank_id\": \"gh.29.uk\",\n \"account_id\": \"1ca8a7e4-6d02-48e3-a029-0b2bf89de9f0\",\n },\n \"to\": {\n \"bank_id\": \"gh.29.uk\",\n \"account_id\": \"2ca8a7e4-6d02-48e3-a029-0b2bf89de9f0\",\n },\n \"value\": {\n \"currency\": \"GBP\",\n \"amount\": \"10\"\n },\n \"description\": \"this is for work\",\n \"posted\": \"2017-09-19T02:31:05Z\",\n \"completed\": \"2017-09-19T02:31:05Z\",\n \"type\": \"SANDBOX_TAN\",\n \"charge_policy\": \"SHARED\"\n}\n\nWhen you need the counterparty to counterparty, need to omit bank_id and account_id field.eg:\n{\n \"from\": {\n \"counterparty_id\": \"f6392b7d-4218-45ea-b9a7-eaa71c0202f9\"\n },\n \"to\": {\n \"counterparty_id\": \"26392b7d-4218-45ea-b9a7-eaa71c0202f9\"\n },\n \"value\": {\n \"currency\": \"GBP\",\n \"amount\": \"10\"\n },\n \"description\": \"this is for work\",\n \"posted\": \"2017-09-19T02:31:05Z\",\n \"completed\": \"2017-09-19T02:31:05Z\",\n \"type\": \"SANDBOX_TAN\",\n \"charge_policy\": \"SHARED\"\n}\n\nor, you can counterparty to account\n{\n \"from\": {\n \"counterparty_id\": \"f6392b7d-4218-45ea-b9a7-eaa71c0202f9\"\n },\n \"to\": {\n \"bank_id\": \"gh.29.uk\",\n \"account_id\": \"8ca8a7e4-6d02-48e3-a029-0b2bf89de9f0\",\n },\n \"value\": {\n \"currency\": \"GBP\",\n \"amount\": \"10\"\n },\n \"description\": \"this is for work\",\n \"posted\": \"2017-09-19T02:31:05Z\",\n \"completed\": \"2017-09-19T02:31:05Z\",\n \"type\": \"SANDBOX_TAN\",\n \"charge_policy\": \"SHARED\"\n}\n\nThis call is experimental.\n \n\nAuthentication is Mandatory\n\n\n**JSON request body fields:**\n\n\n\n[**amount**](/glossary#): 10.12\n\n\n\n[**charge_policy**](/glossary#): SHARED\n\n\n\n[**completed**](/glossary#completed): 2020-01-27\n\n\n\n[**currency**](/glossary#): EUR\n\n\n\n[**description**](/glossary#description): This an optional field. Maximum length is 2000. It can be any characters here.\n\n\n\n[**from**](/glossary#from): \n\n\n\n[**posted**](/glossary#posted): 2020-01-27\n\n\n\n[**to**](/glossary#to): \n\n\n\n[**type**](/glossary#type): \n\n\n\n[**value**](/glossary#): 5987953\n\n\n\n[account_id](/glossary#): 8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0\n\n\n\n[bank_id](/glossary#): gh.29.uk\n\n\n\n[counterparty_id](/glossary#): 9fg8a7e4-6d02-40e3-a129-0b2bf89de8uh\n\n\n\n\n\n**JSON response body fields:**\n\n\n\n[**amount**](/glossary#): 10.12\n\n\n\n[**charge_policy**](/glossary#): SHARED\n\n\n\n[**completed**](/glossary#completed): 2020-01-27\n\n\n\n[**currency**](/glossary#): EUR\n\n\n\n[**description**](/glossary#description): This an optional field. Maximum length is 2000. It can be any characters here.\n\n\n\n[**from**](/glossary#from): \n\n\n\n[**posted**](/glossary#posted): 2020-01-27\n\n\n\n[**to**](/glossary#to): \n\n\n\n[**transaction_id**](/glossary#): 2fg8a7e4-6d02-40e3-a129-0b2bf89de8ub\n\n\n\n[**transaction_request_type**](/glossary#): SEPA\n\n\n\n[**value**](/glossary#): 5987953\n\n\n\n[account_id](/glossary#): 8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0\n\n\n\n[bank_id](/glossary#): gh.29.uk\n\n\n\n[counterparty_id](/glossary#): 9fg8a7e4-6d02-40e3-a129-0b2bf89de8uh\n\n\n","example_request_body":{"from":{"bank_id":"gh.29.uk","account_id":"8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0","counterparty_id":"9fg8a7e4-6d02-40e3-a129-0b2bf89de8uh"},"to":{"bank_id":"gh.29.uk","account_id":"8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0","counterparty_id":"9fg8a7e4-6d02-40e3-a129-0b2bf89de8uh"},"value":{"currency":"EUR","amount":"0"},"description":"this is for work","posted":"1100-01-01T01:01:01Z","completed":"1100-01-01T01:01:01Z","type":"SANDBOX_TAN","charge_policy":"SHARED"},"success_response_body":{"transaction_id":"2fg8a7e4-6d02-40e3-a129-0b2bf89de8ub","from":{"bank_id":"gh.29.uk","account_id":"8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0","counterparty_id":"9fg8a7e4-6d02-40e3-a129-0b2bf89de8uh"},"to":{"bank_id":"gh.29.uk","account_id":"8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0","counterparty_id":"9fg8a7e4-6d02-40e3-a129-0b2bf89de8uh"},"value":{"currency":"EUR","amount":"0"},"description":"this is for work","posted":"1100-01-01T01:01:01Z","completed":"1100-01-01T01:01:01Z","transaction_request_type":"SANDBOX_TAN","charge_policy":"SHARED"},"error_response_bodies":["OBP-10001: Incorrect json format.","OBP-30001: Bank not found. Please specify a valid value for BANK_ID.","OBP-30003: Account not found. Please specify a valid value for ACCOUNT_ID.","OBP-30017: Counterparty not found. Please specify a valid value for COUNTERPARTY_ID.","OBP-10002: Invalid Number. Could not convert value to a number.","OBP-40008: Can't send a payment with a value of 0 or less.","OBP-40003: Transaction Request Currency must be the same as From Account Currency.","OBP-50000: Unknown Error.","OBP-20001: User not logged in. Authentication is required!","OBP-20006: User is missing one or more roles: "],"tags":["Transaction-Request"],"typed_request_body":{"type":"object","properties":{"type":{"type":"string"},"completed":{"type":"string"},"description":{"type":"string"},"from":{"type":"object","properties":{"bank_id":{"type":"string"},"account_id":{"type":"string"},"counterparty_id":{"type":"string"}}},"to":{"type":"object","properties":{"bank_id":{"type":"string"},"account_id":{"type":"string"},"counterparty_id":{"type":"string"}}},"value":{"type":"object","properties":{"currency":{"type":"string"},"amount":{"type":"string"}}},"charge_policy":{"type":"string"},"posted":{"type":"string"}}},"typed_success_response_body":{"type":"object","properties":{"description":{"type":"string"},"completed":{"type":"string","format":"date-time"},"from":{"type":"object","properties":{"bank_id":{"type":"string"},"account_id":{"type":"string"},"counterparty_id":{"type":"string"}}},"transaction_request_type":{"type":"string"},"to":{"type":"object","properties":{"bank_id":{"type":"string"},"account_id":{"type":"string"},"counterparty_id":{"type":"string"}}},"value":{"type":"object","properties":{"currency":{"type":"string"},"amount":{"type":"string"}}},"charge_policy":{"type":"string"},"transaction_id":{"type":"string"},"posted":{"type":"string","format":"date-time"}}},"roles":[{"role":"CanCreateHistoricalTransaction","requires_bank_id":false}],"is_featured":false,"special_instructions":"","specified_url":"/obp/v4.0.0/management/historical/transactions ","connector_methods":[]},{"operation_id":"OBPv4.0.0-createTransactionRequestAttribute","implemented_by":{"version":"OBPv4.0.0","function":"createTransactionRequestAttribute"},"request_verb":"POST","request_url":"/obp/v4.0.0/banks/BANK_ID/accounts/ACCOUNT_ID/transaction-requests/TRANSACTION_REQUEST_ID/attribute","summary":"Create Transaction Request Attribute","description":"Create Transaction Request Attribute
\nThe type field must be one of "STRING", "INTEGER", "DOUBLE" or DATE_WITH_DAY"
\nAuthentication is Mandatory
\nURL Parameters:
\nACCOUNT_ID: 8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0
\nBANK_ID: gh.29.uk
\nTRANSACTION_REQUEST_ID: 8138a7e4-6d02-40e3-a129-0b2bf89de9f1
\nJSON request body fields:
\nname: ACCOUNT_MANAGEMENT_FEE
\ntype:
\nvalue: 5987953
\nJSON response body fields:
\nname: ACCOUNT_MANAGEMENT_FEE
\ntransaction_request_attribute_id: 7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh
\ntype:
\nvalue: 5987953
\n","description_markdown":"Create Transaction Request Attribute\n\nThe type field must be one of \"STRING\", \"INTEGER\", \"DOUBLE\" or DATE_WITH_DAY\"\n\nAuthentication is Mandatory\n\n\n**URL Parameters:**\n\n[ACCOUNT_ID](/glossary#Account.account_id): 8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0\n\n\n\n[BANK_ID](/glossary#Bank.bank_id): gh.29.uk\n\n\n\n[TRANSACTION_REQUEST_ID](/glossary#): 8138a7e4-6d02-40e3-a129-0b2bf89de9f1\n\n\n\n\n\n**JSON request body fields:**\n\n\n\n[**name**](/glossary#name): ACCOUNT_MANAGEMENT_FEE\n\n\n\n[**type**](/glossary#type): \n\n\n\n[**value**](/glossary#): 5987953\n\n\n\n\n\n**JSON response body fields:**\n\n\n\n[**name**](/glossary#name): ACCOUNT_MANAGEMENT_FEE\n\n\n\n[**transaction_request_attribute_id**](/glossary#): 7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh\n\n\n\n[**type**](/glossary#type): \n\n\n\n[**value**](/glossary#): 5987953\n\n\n","example_request_body":{"name":"HOUSE_RENT","type":"DATE_WITH_DAY","value":"123456789"},"success_response_body":{"transaction_request_attribute_id":"7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh","name":"HOUSE_RENT","type":"DATE_WITH_DAY","value":"123456789"},"error_response_bodies":["OBP-20001: User not logged in. Authentication is required!","OBP-30001: Bank not found. Please specify a valid value for BANK_ID.","OBP-30018: Bank Account not found. Please specify valid values for BANK_ID and ACCOUNT_ID. ","OBP-10001: Incorrect json format.","OBP-50000: Unknown Error.","OBP-20006: User is missing one or more roles: "],"tags":["Transaction-Request"],"typed_request_body":{"type":"object","properties":{"name":{"type":"string"},"type":{"type":"string"},"value":{"type":"string"}}},"typed_success_response_body":{"type":"object","properties":{"name":{"type":"string"},"type":{"type":"string"},"transaction_request_attribute_id":{"type":"string"},"value":{"type":"string"}}},"roles":[{"role":"CanCreateTransactionRequestAttributeAtOneBank","requires_bank_id":true}],"is_featured":false,"special_instructions":"","specified_url":"/obp/v4.0.0/banks/BANK_ID/accounts/ACCOUNT_ID/transaction-requests/TRANSACTION_REQUEST_ID/attribute","connector_methods":[]},{"operation_id":"OBPv4.0.0-getTransactionRequest","implemented_by":{"version":"OBPv4.0.0","function":"getTransactionRequest"},"request_verb":"GET","request_url":"/obp/v4.0.0/banks/BANK_ID/accounts/ACCOUNT_ID/VIEW_ID/transaction-requests/TRANSACTION_REQUEST_ID","summary":"Get Transaction Request","description":"Returns transaction request for transaction specified by TRANSACTION_REQUEST_ID and for account specified by ACCOUNT_ID at bank specified by BANK_ID.
\nThe VIEW_ID specified must be 'owner' and the user must have access to this view.
\nVersion 2.0.0 now returns charge information.
\nTransaction Requests serve to initiate transactions that may or may not proceed. They contain information including:
\nPSD2 Context: PSD2 requires transparency of charges to the customer.
\nThis endpoint provides the charge that would be applied if the Transaction Request proceeds - and a record of that charge there after.
\nThe customer can proceed with the Transaction by answering the security challenge.
Authentication is Mandatory
\nURL Parameters:
\nACCOUNT_ID: 8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0
\nBANK_ID: gh.29.uk
\nTRANSACTION_REQUEST_ID: 8138a7e4-6d02-40e3-a129-0b2bf89de9f1
\nVIEW_ID: owner
\nJSON response body fields:
\n\naccount_id: 8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0
\n\namount: 10.12
\nbank_code: CGHZ
\nbank_id: gh.29.uk
\n\n\n\n\ncounterparty_id: 9fg8a7e4-6d02-40e3-a129-0b2bf89de8uh
\n\n\ncurrency: EUR
\ndate_of_birth: 2018-03-09
\n\ndescription: This an optional field. Maximum length is 2000. It can be any characters here.
\n\n\nfrom:
\nfuture_date: 20200127
\niban: DE91 1000 0000 0123 4567 89
\nid: d8839721-ad8f-45dd-9f78-2080414b93f9
\ninstructedAmount: 100
\n\nlegal_name: Eveline Tripman
\nmessage: 123456
\nmobile_phone_number: +49 30 901820
\nname: ACCOUNT_MANAGEMENT_FEE
\n\n\notherAccountRoutingAddress: otherAccountRoutingAddress
\notherAccountRoutingScheme: otherAccountRoutingScheme
\notherAccountSecondaryRoutingAddress: otherAccountSecondaryRoutingAddress
\notherAccountSecondaryRoutingScheme: otherAccountSecondaryRoutingScheme
\notherBankRoutingAddress: otherBankRoutingAddress
\notherBankRoutingScheme: otherBankRoutingScheme
\notherBranchRoutingAddress: otherBranchRoutingAddress
\notherBranchRoutingScheme: otherBranchRoutingScheme
\nstart_date: 2020-01-27
\n\n\nto:
\n\n\ntype:
\nvalue: 5987953
\n\n\n\n\nto_simple: to_simple
\n\n\n\n","description_markdown":"Returns transaction request for transaction specified by TRANSACTION_REQUEST_ID and for account specified by ACCOUNT_ID at bank specified by BANK_ID.\n\nThe VIEW_ID specified must be 'owner' and the user must have access to this view.\n\nVersion 2.0.0 now returns charge information.\n\nTransaction Requests serve to initiate transactions that may or may not proceed. They contain information including:\n\n* Transaction Request Id\n* Type\n* Status (INITIATED, COMPLETED)\n* Challenge (in order to confirm the request)\n* From Bank / Account\n* Details including Currency, Value, Description and other initiation information specific to each type. (Could potentialy include a list of future transactions.)\n* Related Transactions\n\nPSD2 Context: PSD2 requires transparency of charges to the customer.\nThis endpoint provides the charge that would be applied if the Transaction Request proceeds - and a record of that charge there after.\nThe customer can proceed with the Transaction by answering the security challenge.\n\n \n\nAuthentication is Mandatory\n\n\n**URL Parameters:**\n\n[ACCOUNT_ID](/glossary#Account.account_id): 8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0\n\n\n\n[BANK_ID](/glossary#Bank.bank_id): gh.29.uk\n\n\n\n[TRANSACTION_REQUEST_ID](/glossary#): 8138a7e4-6d02-40e3-a129-0b2bf89de9f1\n\n\n\n[VIEW_ID](/glossary#this_view_id): owner\n\n\n\n\n\n**JSON response body fields:**\n\n\n\n[**account**](/glossary#Account): \n\n\n\n[**account_id**](/glossary#): 8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0\n\n\n\n[**allowed_attempts**](/glossary#allowed_attempts): 5\n\n\n\n[**amount**](/glossary#): 10.12\n\n\n\n[**bank_code**](/glossary#bank_code): CGHZ\n\n\n\n[**bank_id**](/glossary#): gh.29.uk\n\n\n\n[**branch_number**](/glossary#branch_number): \n\n\n\n[**challenge**](/glossary#challenge): \n\n\n\n[**challenge_type**](/glossary#challenge_type): \n\n\n\n[**charge**](/glossary#charge): \n\n\n\n[**counterparty_id**](/glossary#): 9fg8a7e4-6d02-40e3-a129-0b2bf89de8uh\n\n\n\n[**creditorAccount**](/glossary#creditoraccount): \n\n\n\n[**creditorName**](/glossary#creditorname): \n\n\n\n[**currency**](/glossary#): EUR\n\n\n\n[**date_of_birth**](/glossary#): 2018-03-09\n\n\n\n[**debtorAccount**](/glossary#debtoraccount): \n\n\n\n[**description**](/glossary#description): This an optional field. Maximum length is 2000. It can be any characters here.\n\n\n\n[**details**](/glossary#details): \n\n\n\n[**end_date**](/glossary#end_date): \n\n\n\n[**from**](/glossary#from): \n\n\n\n[**future_date**](/glossary#future_date): 20200127\n\n\n\n[**iban**](/glossary#): DE91 1000 0000 0123 4567 89\n\n\n\n[**id**](/glossary#id): d8839721-ad8f-45dd-9f78-2080414b93f9\n\n\n\n[**instructedAmount**](/glossary#instructedamount): 100\n\n\n\n[**kyc_document**](/glossary#kyc_document): \n\n\n\n[**legal_name**](/glossary#): Eveline Tripman\n\n\n\n[**message**](/glossary#message): 123456\n\n\n\n[**mobile_phone_number**](/glossary#mobile_phone_number): +49 30 901820\n\n\n\n[**name**](/glossary#name): ACCOUNT_MANAGEMENT_FEE\n\n\n\n[**nickname**](/glossary#nickname): \n\n\n\n[**number**](/glossary#number): \n\n\n\n[**otherAccountRoutingAddress**](/glossary#): otherAccountRoutingAddress\n\n\n\n[**otherAccountRoutingScheme**](/glossary#): otherAccountRoutingScheme\n\n\n\n[**otherAccountSecondaryRoutingAddress**](/glossary#): otherAccountSecondaryRoutingAddress\n\n\n\n[**otherAccountSecondaryRoutingScheme**](/glossary#): otherAccountSecondaryRoutingScheme\n\n\n\n[**otherBankRoutingAddress**](/glossary#): otherBankRoutingAddress\n\n\n\n[**otherBankRoutingScheme**](/glossary#): otherBankRoutingScheme\n\n\n\n[**otherBranchRoutingAddress**](/glossary#): otherBranchRoutingAddress\n\n\n\n[**otherBranchRoutingScheme**](/glossary#): otherBranchRoutingScheme\n\n\n\n[**start_date**](/glossary#): 2020-01-27\n\n\n\n[**status**](/glossary#status): \n\n\n\n[**summary**](/glossary#summary): \n\n\n\n[**to**](/glossary#to): \n\n\n\n[**transaction_ids**](/glossary#transaction_ids): \n\n\n\n[**transfer_type**](/glossary#transfer_type): \n\n\n\n[**type**](/glossary#type): \n\n\n\n[**value**](/glossary#): 5987953\n\n\n\n[to_counterparty](/glossary#to_counterparty): \n\n\n\n[to_sandbox_tan](/glossary#to_sandbox_tan): \n\n\n\n[to_sepa](/glossary#to_sepa): \n\n\n\n[to_sepa_credit_transfers](/glossary#to_sepa_credit_transfers): \n\n\n\n[to_simple](/glossary#): to_simple\n\n\n\n[to_transfer_to_account](/glossary#to_transfer_to_account): \n\n\n\n[to_transfer_to_atm](/glossary#to_transfer_to_atm): \n\n\n\n[to_transfer_to_phone](/glossary#to_transfer_to_phone): \n\n\n","success_response_body":{"id":"4050046c-63b3-4868-8a22-14b4181d33a6","type":"SANDBOX_TAN","from":{"bank_id":"gh.29.uk","account_id":"8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0"},"details":{"to_sandbox_tan":{"bank_id":"String","account_id":"String"},"to_sepa":{"iban":"String"},"to_counterparty":{"counterparty_id":"9fg8a7e4-6d02-40e3-a129-0b2bf89de8uh"},"to_simple":{"otherBankRoutingScheme":"BIC","otherBankRoutingAddress":"GENODEM1GLS","otherBranchRoutingScheme":"BRANCH-CODE","otherBranchRoutingAddress":"DERBY6","otherAccountRoutingScheme":"IBAN","otherAccountRoutingAddress":"DE91 1000 0000 0123 4567 89","otherAccountSecondaryRoutingScheme":"IBAN","otherAccountSecondaryRoutingAddress":"DE91 1000 0000 0123 4567 89"},"to_transfer_to_phone":{"value":{"currency":"EUR","amount":"0"},"description":"String","message":"String","from":{"mobile_phone_number":"+44 07972 444 876","nickname":"String"},"to":{"mobile_phone_number":"+44 07972 444 876"}},"to_transfer_to_atm":{"value":{"currency":"EUR","amount":"0"},"description":"String","message":"String","from":{"mobile_phone_number":"+44 07972 444 876","nickname":"String"},"to":{"legal_name":"Eveline Tripman","date_of_birth":"20181230","mobile_phone_number":"+44 07972 444 876","kyc_document":{"type":"String","number":"String"}}},"to_transfer_to_account":{"value":{"currency":"EUR","amount":"0"},"description":"String","transfer_type":"String","future_date":"20181230","to":{"name":"String","bank_code":"String","branch_number":"String","account":{"number":"String","iban":"String"}}},"to_sepa_credit_transfers":{"debtorAccount":{"iban":"12345"},"instructedAmount":{"currency":"EUR","amount":"0"},"creditorAccount":{"iban":"54321"},"creditorName":"John Miles"},"value":{"currency":"EUR","amount":"100"},"description":"This an optional field. Maximum length is 2000. It can be any characters here."},"transaction_ids":["902ba3bb-dedd-45e7-9319-2fd3f2cd98a1"],"status":"COMPLETED","start_date":"1100-01-01T00:00:00Z","end_date":"1100-01-01T00:00:00Z","challenge":{"id":"be1a183d-b301-4b83-b855-5eeffdd3526f","allowed_attempts":3,"challenge_type":"SANDBOX_TAN"},"charge":{"summary":"Rent the flat","value":{"currency":"EUR","amount":"0"}}},"error_response_bodies":["OBP-20001: User not logged in. Authentication is required!","OBP-30001: Bank not found. Please specify a valid value for BANK_ID.","OBP-30018: Bank Account not found. Please specify valid values for BANK_ID and ACCOUNT_ID. ","OBP-20017: Current user does not have access to the view. Please specify a valid value for VIEW_ID.","OBP-60010: Get Transaction Requests Exception. ","OBP-50000: Unknown Error."],"tags":["Transaction-Request","Payment Initiation Service (PIS)","PSD2"],"typed_success_response_body":{"type":"object","properties":{"type":{"type":"string"},"challenge":{"type":"object","properties":{"challenge_type":{"type":"string"},"allowed_attempts":{"type":"integer"},"id":{"type":"string"}}},"status":{"type":"string"},"end_date":{"type":"string","format":"date-time"},"charge":{"type":"object","properties":{"summary":{"type":"string"},"value":{"type":"object","properties":{"currency":{"type":"string"},"amount":{"type":"string"}}}}},"transaction_ids":{"type":"array","items":{"type":"string"}},"from":{"type":"object","properties":{"bank_id":{"type":"string"},"account_id":{"type":"string"}}},"details":{"type":"object","properties":{"description":{"type":"string"},"to_sandbox_tan":{"type":"object","properties":{"account_id":{"type":"string"},"bank_id":{"type":"string"}}},"value":{"type":"object","properties":{"currency":{"type":"string"},"amount":{"type":"string"}}},"to_transfer_to_phone":{"type":"object","properties":{"description":{"type":"string"},"message":{"type":"string"},"from":{"type":"object","properties":{"nickname":{"type":"string"},"mobile_phone_number":{"type":"string"}}},"to":{"type":"object","properties":{"mobile_phone_number":{"type":"string"}}},"value":{"type":"object","properties":{"currency":{"type":"string"},"amount":{"type":"string"}}}}},"to_sepa":{"type":"object","properties":{"iban":{"type":"string"}}},"to_simple":{"type":"object","properties":{"otherBankRoutingAddress":{"type":"string"},"otherAccountSecondaryRoutingAddress":{"type":"string"},"otherBranchRoutingScheme":{"type":"string"},"otherAccountRoutingScheme":{"type":"string"},"otherAccountRoutingAddress":{"type":"string"},"otherBankRoutingScheme":{"type":"string"},"otherBranchRoutingAddress":{"type":"string"},"otherAccountSecondaryRoutingScheme":{"type":"string"}}},"to_counterparty":{"type":"object","properties":{"counterparty_id":{"type":"string"}}},"to_transfer_to_account":{"type":"object","properties":{"to":{"type":"object","properties":{"name":{"type":"string"},"account":{"type":"object","properties":{"number":{"type":"string"},"iban":{"type":"string"}}},"bank_code":{"type":"string"},"branch_number":{"type":"string"}}},"transfer_type":{"type":"string"},"description":{"type":"string"},"future_date":{"type":"string"},"value":{"type":"object","properties":{"currency":{"type":"string"},"amount":{"type":"string"}}}}},"to_sepa_credit_transfers":{"type":"object","properties":{"instructedAmount":{"type":"object","properties":{"currency":{"type":"string"},"amount":{"type":"string"}}},"debtorAccount":{"type":"object","properties":{"iban":{"type":"string"}}},"creditorAccount":{"type":"object","properties":{"iban":{"type":"string"}}},"creditorName":{"type":"string"}}},"to_transfer_to_atm":{"type":"object","properties":{"description":{"type":"string"},"message":{"type":"string"},"from":{"type":"object","properties":{"nickname":{"type":"string"},"mobile_phone_number":{"type":"string"}}},"value":{"type":"object","properties":{"currency":{"type":"string"},"amount":{"type":"string"}}},"to":{"type":"object","properties":{"date_of_birth":{"type":"string"},"kyc_document":{"type":"object","properties":{"type":{"type":"string"},"number":{"type":"string"}}},"legal_name":{"type":"string"},"mobile_phone_number":{"type":"string"}}}}}}},"start_date":{"type":"string","format":"date-time"},"id":{"type":"string"}}},"is_featured":false,"special_instructions":"","specified_url":"/obp/v4.0.0/banks/BANK_ID/accounts/ACCOUNT_ID/VIEW_ID/transaction-requests/TRANSACTION_REQUEST_ID","connector_methods":[]},{"operation_id":"OBPv4.0.0-createTransactionRequestRefund","implemented_by":{"version":"OBPv4.0.0","function":"createTransactionRequestRefund"},"request_verb":"POST","request_url":"/obp/v4.0.0/banks/BANK_ID/accounts/ACCOUNT_ID/VIEW_ID/transaction-request-types/REFUND/transaction-requests","summary":"Create Transaction Request (REFUND)","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.
\nIn the from
object, you have two choices :
\n- Use bank_id
and account_id
fields if the other account is registered on the OBP-API
\n- 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.
\n(This case is not managed by the OBP-API and require an external adapter)
Initiate a Payment via creating a Transaction Request.
\nIn OBP, a transaction request
may or may not result in a transaction
. However, a transaction
only has one possible state: completed.
A Transaction Request
can have one of several states: INITIATED, NEXT_CHALLENGE_PENDING etc.
Transactions
are modeled on items in a bank statement that represent the movement of money.
Transaction Requests
are requests to move money which may or may not succeed and thus result in a Transaction
.
A Transaction Request
might create a security challenge that needs to be answered before the Transaction Request
proceeds.
\nIn case 1 person needs to answer security challenge we have next flow of state of an transaction request
:
\nINITIATED => COMPLETED
\nIn case n persons needs to answer security challenge we have next flow of state of an transaction request
:
\nINITIATED => NEXT_CHALLENGE_PENDING => ... => NEXT_CHALLENGE_PENDING => COMPLETED
The security challenge is bound to a user i.e. in case of right answer and the user is different than expected one the challenge will fail.
\nRule for calculating number of security challenges:
\nIf product Account attribute REQUIRED_CHALLENGE_ANSWERS=N then create N challenges
\n(one for every user that has a View where permission "can_add_transaction_request_to_any_account"=true)
\nIn case REQUIRED_CHALLENGE_ANSWERS is not defined as an account attribute default value is 1.
Transaction Requests contain charge information giving the client the opportunity to proceed or not (as long as the challenge level is appropriate).
\nTransaction Requests can have one of several Transaction Request Types which expect different bodies. The escaped body is returned in the details key of the GET response.
\nThis provides some commonality and one URL for many different payment or transfer types with enough flexibility to validate them differently.
The payer is set in the URL. Money comes out of the BANK_ID and ACCOUNT_ID specified in the URL.
\nIn sandbox mode, TRANSACTION_REQUEST_TYPE is commonly set to ACCOUNT. See getTransactionRequestTypesSupportedByBank for all supported types.
\nIn sandbox mode, if the amount is less than 1000 EUR (any currency, unless it is set differently on this server), the transaction request will create a transaction without a challenge, else the Transaction Request will be set to INITIALISED and a challenge will need to be answered.
\nIf a challenge is created you must answer it using Answer Transaction Request Challenge before the Transaction is created.
\nYou can transfer between different currency accounts. (new in 2.0.0). The currency in body must match the sending account.
\nThe following static FX rates are available in sandbox mode:
\n\nTransaction Requests satisfy PSD2 requirements thus:
\n1) A transaction can be initiated by a third party application.
\n2) The customer is informed of the charge that will incurred.
\n3) The call supports delegated authentication (OAuth)
\nSee this python code for a complete example of this flow.
\nThere is further documentation here
\nAuthentication is Mandatory
\nURL Parameters:
\nACCOUNT_ID: 8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0
\nBANK_ID: gh.29.uk
\nREFUND: REFUND
\nVIEW_ID: owner
\nJSON request body fields:
\namount: 10.12
\ncounterparty_id: 9fg8a7e4-6d02-40e3-a129-0b2bf89de8uh
\ncurrency: EUR
\ndescription: This an optional field. Maximum length is 2000. It can be any characters here.
\nreason_code: reason_code
\nrefund: refund
\ntransaction_id: 2fg8a7e4-6d02-40e3-a129-0b2bf89de8ub
\nvalue: 5987953
\naccount_id: 8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0
\nbank_id: gh.29.uk
\ncounterparty_id: 9fg8a7e4-6d02-40e3-a129-0b2bf89de8uh
\nfrom:
\nto:
\nJSON response body fields:
\n\naccount_id: 8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0
\n\namount: 10.12
\nbank_code: CGHZ
\nbank_id: gh.29.uk
\n\n\nchallenges: challenges
\n\ncounterparty_id: 9fg8a7e4-6d02-40e3-a129-0b2bf89de8uh
\n\n\ncurrency: EUR
\ndate_of_birth: 2018-03-09
\n\ndescription: This an optional field. Maximum length is 2000. It can be any characters here.
\n\n\nfrom:
\nfuture_date: 20200127
\niban: DE91 1000 0000 0123 4567 89
\nid: d8839721-ad8f-45dd-9f78-2080414b93f9
\ninstructedAmount: 100
\n\nlegal_name: Eveline Tripman
\nlink:
\nmessage: 123456
\nmobile_phone_number: +49 30 901820
\nname: ACCOUNT_MANAGEMENT_FEE
\n\n\notherAccountRoutingAddress: otherAccountRoutingAddress
\notherAccountRoutingScheme: otherAccountRoutingScheme
\notherAccountSecondaryRoutingAddress: otherAccountSecondaryRoutingAddress
\notherAccountSecondaryRoutingScheme: otherAccountSecondaryRoutingScheme
\notherBankRoutingAddress: otherBankRoutingAddress
\notherBankRoutingScheme: otherBankRoutingScheme
\notherBranchRoutingAddress: otherBranchRoutingAddress
\notherBranchRoutingScheme: otherBranchRoutingScheme
\nstart_date: 2020-01-27
\n\n\nto:
\n\n\ntype:
\nuser_id: 9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1
\nvalue: 5987953
\n\n\n\n\nto_simple: to_simple
\n\n\n\n","description_markdown":"Either the `from` or the `to` field must be filled. Those fields refers to the information about the party that will be refunded.\n\nIn case the `from` object is used, it means that the refund comes from the part that sent you a transaction.\nIn the `from` object, you have two choices :\n- Use `bank_id` and `account_id` fields if the other account is registered on the OBP-API\n- Use the `counterparty_id` field in case the counterparty account is out of the OBP-API\n\nIn 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.\n(This case is not managed by the OBP-API and require an external adapter)\n\n\nInitiate a Payment via creating a Transaction Request.\n\nIn OBP, a `transaction request` may or may not result in a `transaction`. However, a `transaction` only has one possible state: completed.\n\nA `Transaction Request` can have one of several states: INITIATED, NEXT_CHALLENGE_PENDING etc.\n\n`Transactions` are modeled on items in a bank statement that represent the movement of money.\n\n`Transaction Requests` are requests to move money which may or may not succeed and thus result in a `Transaction`.\n\nA `Transaction Request` might create a security challenge that needs to be answered before the `Transaction Request` proceeds.\nIn case 1 person needs to answer security challenge we have next flow of state of an `transaction request`:\n INITIATED => COMPLETED\nIn case n persons needs to answer security challenge we have next flow of state of an `transaction request`:\n INITIATED => NEXT_CHALLENGE_PENDING => ... => NEXT_CHALLENGE_PENDING => COMPLETED\n\nThe security challenge is bound to a user i.e. in case of right answer and the user is different than expected one the challenge will fail.\n\nRule for calculating number of security challenges:\nIf product Account attribute REQUIRED_CHALLENGE_ANSWERS=N then create N challenges\n(one for every user that has a View where permission \"can_add_transaction_request_to_any_account\"=true)\nIn case REQUIRED_CHALLENGE_ANSWERS is not defined as an account attribute default value is 1.\n\nTransaction Requests contain charge information giving the client the opportunity to proceed or not (as long as the challenge level is appropriate).\n\nTransaction Requests can have one of several Transaction Request Types which expect different bodies. The escaped body is returned in the details key of the GET response.\nThis provides some commonality and one URL for many different payment or transfer types with enough flexibility to validate them differently.\n\nThe payer is set in the URL. Money comes out of the BANK_ID and ACCOUNT_ID specified in the URL.\n\nIn sandbox mode, TRANSACTION_REQUEST_TYPE is commonly set to ACCOUNT. See getTransactionRequestTypesSupportedByBank for all supported types.\n\nIn sandbox mode, if the amount is less than 1000 EUR (any currency, unless it is set differently on this server), the transaction request will create a transaction without a challenge, else the Transaction Request will be set to INITIALISED and a challenge will need to be answered.\n\nIf a challenge is created you must answer it using Answer Transaction Request Challenge before the Transaction is created.\n\nYou can transfer between different currency accounts. (new in 2.0.0). The currency in body must match the sending account.\n\nThe following static FX rates are available in sandbox mode:\n\nhttps://apiexplorer-ii-sandbox.openbankproject.com//more?version=OBPv4.0.0&list-all-banks=false&core=&psd2=&obwg=#OBPv2_2_0-getCurrentFxRate\n\n\nTransaction Requests satisfy PSD2 requirements thus:\n\n1) A transaction can be initiated by a third party application.\n\n2) The customer is informed of the charge that will incurred.\n\n3) The call supports delegated authentication (OAuth)\n\nSee [this python code](https://github.com/OpenBankProject/Hello-OBP-DirectLogin-Python/blob/master/hello_payments.py) for a complete example of this flow.\n\nThere is further documentation [here](https://github.com/OpenBankProject/OBP-API/wiki/Transaction-Requests)\n\n\n\n \n\nAuthentication is Mandatory\n\n\n**URL Parameters:**\n\n[ACCOUNT_ID](/glossary#Account.account_id): 8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0\n\n\n\n[BANK_ID](/glossary#Bank.bank_id): gh.29.uk\n\n\n\n[REFUND](/glossary#): REFUND\n\n\n\n[VIEW_ID](/glossary#this_view_id): owner\n\n\n\n\n\n**JSON request body fields:**\n\n\n\n[**amount**](/glossary#): 10.12\n\n\n\n[**counterparty_id**](/glossary#): 9fg8a7e4-6d02-40e3-a129-0b2bf89de8uh\n\n\n\n[**currency**](/glossary#): EUR\n\n\n\n[**description**](/glossary#description): This an optional field. Maximum length is 2000. It can be any characters here.\n\n\n\n[**reason_code**](/glossary#): reason_code\n\n\n\n[**refund**](/glossary#): refund\n\n\n\n[**transaction_id**](/glossary#): 2fg8a7e4-6d02-40e3-a129-0b2bf89de8ub\n\n\n\n[**value**](/glossary#): 5987953\n\n\n\n[account_id](/glossary#): 8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0\n\n\n\n[bank_id](/glossary#): gh.29.uk\n\n\n\n[**counterparty_id**](/glossary#): 9fg8a7e4-6d02-40e3-a129-0b2bf89de8uh\n\n\n\n[from](/glossary#from): \n\n\n\n[to](/glossary#to): \n\n\n\n\n\n**JSON response body fields:**\n\n\n\n[**account**](/glossary#Account): \n\n\n\n[**account_id**](/glossary#): 8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0\n\n\n\n[**allowed_attempts**](/glossary#allowed_attempts): 5\n\n\n\n[**amount**](/glossary#): 10.12\n\n\n\n[**bank_code**](/glossary#bank_code): CGHZ\n\n\n\n[**bank_id**](/glossary#): gh.29.uk\n\n\n\n[**branch_number**](/glossary#branch_number): \n\n\n\n[**challenge_type**](/glossary#challenge_type): \n\n\n\n[**challenges**](/glossary#): challenges\n\n\n\n[**charge**](/glossary#charge): \n\n\n\n[**counterparty_id**](/glossary#): 9fg8a7e4-6d02-40e3-a129-0b2bf89de8uh\n\n\n\n[**creditorAccount**](/glossary#creditoraccount): \n\n\n\n[**creditorName**](/glossary#creditorname): \n\n\n\n[**currency**](/glossary#): EUR\n\n\n\n[**date_of_birth**](/glossary#): 2018-03-09\n\n\n\n[**debtorAccount**](/glossary#debtoraccount): \n\n\n\n[**description**](/glossary#description): This an optional field. Maximum length is 2000. It can be any characters here.\n\n\n\n[**details**](/glossary#details): \n\n\n\n[**end_date**](/glossary#end_date): \n\n\n\n[**from**](/glossary#from): \n\n\n\n[**future_date**](/glossary#future_date): 20200127\n\n\n\n[**iban**](/glossary#): DE91 1000 0000 0123 4567 89\n\n\n\n[**id**](/glossary#id): d8839721-ad8f-45dd-9f78-2080414b93f9\n\n\n\n[**instructedAmount**](/glossary#instructedamount): 100\n\n\n\n[**kyc_document**](/glossary#kyc_document): \n\n\n\n[**legal_name**](/glossary#): Eveline Tripman\n\n\n\n[**link**](/glossary#link): \n\n\n\n[**message**](/glossary#message): 123456\n\n\n\n[**mobile_phone_number**](/glossary#mobile_phone_number): +49 30 901820\n\n\n\n[**name**](/glossary#name): ACCOUNT_MANAGEMENT_FEE\n\n\n\n[**nickname**](/glossary#nickname): \n\n\n\n[**number**](/glossary#number): \n\n\n\n[**otherAccountRoutingAddress**](/glossary#): otherAccountRoutingAddress\n\n\n\n[**otherAccountRoutingScheme**](/glossary#): otherAccountRoutingScheme\n\n\n\n[**otherAccountSecondaryRoutingAddress**](/glossary#): otherAccountSecondaryRoutingAddress\n\n\n\n[**otherAccountSecondaryRoutingScheme**](/glossary#): otherAccountSecondaryRoutingScheme\n\n\n\n[**otherBankRoutingAddress**](/glossary#): otherBankRoutingAddress\n\n\n\n[**otherBankRoutingScheme**](/glossary#): otherBankRoutingScheme\n\n\n\n[**otherBranchRoutingAddress**](/glossary#): otherBranchRoutingAddress\n\n\n\n[**otherBranchRoutingScheme**](/glossary#): otherBranchRoutingScheme\n\n\n\n[**start_date**](/glossary#): 2020-01-27\n\n\n\n[**status**](/glossary#status): \n\n\n\n[**summary**](/glossary#summary): \n\n\n\n[**to**](/glossary#to): \n\n\n\n[**transaction_ids**](/glossary#transaction_ids): \n\n\n\n[**transfer_type**](/glossary#transfer_type): \n\n\n\n[**type**](/glossary#type): \n\n\n\n[**user_id**](/glossary#): 9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1\n\n\n\n[**value**](/glossary#): 5987953\n\n\n\n[to_counterparty](/glossary#to_counterparty): \n\n\n\n[to_sandbox_tan](/glossary#to_sandbox_tan): \n\n\n\n[to_sepa](/glossary#to_sepa): \n\n\n\n[to_sepa_credit_transfers](/glossary#to_sepa_credit_transfers): \n\n\n\n[to_simple](/glossary#): to_simple\n\n\n\n[to_transfer_to_account](/glossary#to_transfer_to_account): \n\n\n\n[to_transfer_to_atm](/glossary#to_transfer_to_atm): \n\n\n\n[to_transfer_to_phone](/glossary#to_transfer_to_phone): \n\n\n","example_request_body":{"to":{"bank_id":"gh.29.uk","account_id":"8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0","counterparty_id":"9fg8a7e4-6d02-40e3-a129-0b2bf89de8uh"},"from":{"counterparty_id":"9fg8a7e4-6d02-40e3-a129-0b2bf89de8uh"},"value":{"currency":"EUR","amount":"0"},"description":"A refund description. ","refund":{"transaction_id":"2fg8a7e4-6d02-40e3-a129-0b2bf89de8ub","reason_code":"CUST"}},"success_response_body":{"id":"4050046c-63b3-4868-8a22-14b4181d33a6","type":"SANDBOX_TAN","from":{"bank_id":"gh.29.uk","account_id":"8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0"},"details":{"to_sandbox_tan":{"bank_id":"String","account_id":"String"},"to_sepa":{"iban":"String"},"to_counterparty":{"counterparty_id":"9fg8a7e4-6d02-40e3-a129-0b2bf89de8uh"},"to_simple":{"otherBankRoutingScheme":"BIC","otherBankRoutingAddress":"GENODEM1GLS","otherBranchRoutingScheme":"BRANCH-CODE","otherBranchRoutingAddress":"DERBY6","otherAccountRoutingScheme":"IBAN","otherAccountRoutingAddress":"DE91 1000 0000 0123 4567 89","otherAccountSecondaryRoutingScheme":"IBAN","otherAccountSecondaryRoutingAddress":"DE91 1000 0000 0123 4567 89"},"to_transfer_to_phone":{"value":{"currency":"EUR","amount":"0"},"description":"String","message":"String","from":{"mobile_phone_number":"+44 07972 444 876","nickname":"String"},"to":{"mobile_phone_number":"+44 07972 444 876"}},"to_transfer_to_atm":{"value":{"currency":"EUR","amount":"0"},"description":"String","message":"String","from":{"mobile_phone_number":"+44 07972 444 876","nickname":"String"},"to":{"legal_name":"Eveline Tripman","date_of_birth":"20181230","mobile_phone_number":"+44 07972 444 876","kyc_document":{"type":"String","number":"String"}}},"to_transfer_to_account":{"value":{"currency":"EUR","amount":"0"},"description":"String","transfer_type":"String","future_date":"20181230","to":{"name":"String","bank_code":"String","branch_number":"String","account":{"number":"String","iban":"String"}}},"to_sepa_credit_transfers":{"debtorAccount":{"iban":"12345"},"instructedAmount":{"currency":"EUR","amount":"0"},"creditorAccount":{"iban":"54321"},"creditorName":"John Miles"},"value":{"currency":"EUR","amount":"100"},"description":"This an optional field. Maximum length is 2000. It can be any characters here."},"transaction_ids":["902ba3bb-dedd-45e7-9319-2fd3f2cd98a1"],"status":"COMPLETED","start_date":"1100-01-01T00:00:00Z","end_date":"1100-01-01T00:00:00Z","challenges":[{"id":"2fg8a7e4-6d02-40e3-a129-0b2bf89de8ub","user_id":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1","allowed_attempts":3,"challenge_type":"OBP_TRANSACTION_REQUEST_CHALLENGE","link":"/obp/v4.0.0/banks/BANK_ID/accounts/ACCOUNT_ID/VIEW_ID/transaction-request-types/TRANSACTION_REQUEST_TYPE/transaction-requests/TRANSACTION_REQUEST_ID/challenge"}],"charge":{"summary":"Rent the flat","value":{"currency":"EUR","amount":"0"}}},"error_response_bodies":["OBP-20001: User not logged in. Authentication is required!","OBP-30111: Invalid Bank Id. The BANK_ID should only contain 0-9/a-z/A-Z/'-'/'.'/'_', the length should be smaller than 255.","OBP-30110: Invalid Account Id. The ACCOUNT_ID should only contain 0-9/a-z/A-Z/'-'/'.'/'_', the length should be smaller than 255.","OBP-10001: Incorrect json format.","OBP-30001: Bank not found. Please specify a valid value for BANK_ID.","OBP-30003: Account not found. Please specify a valid value for ACCOUNT_ID.","OBP-30018: Bank Account not found. Please specify valid values for BANK_ID and ACCOUNT_ID. ","OBP-40002: Insufficient authorisation to create TransactionRequest. The Transaction Request could not be created because the login user doesn't have access to the view of the from account or the consumer doesn't have the access to the view of the from account or the login user does not have the `CanCreateAnyTransactionRequest` role or the view does not have the permission canaddtransactionrequesttoanyaccount.","OBP-40001: Invalid value for TRANSACTION_REQUEST_TYPE","OBP-10001: Incorrect json format.","OBP-10002: Invalid Number. Could not convert value to a number.","OBP-40008: Can't send a payment with a value of 0 or less.","OBP-40003: Transaction Request Currency must be the same as From Account Currency.","OBP-00003: Transaction Requests is disabled in this API instance.","OBP-50000: Unknown Error."],"tags":["Transaction-Request","Payment Initiation Service (PIS)","PSD2"],"typed_request_body":{"type":"object","properties":{"description":{"type":"string"},"to":{"type":"object","properties":{"bank_id":{"type":"string"},"account_id":{"type":"string"},"counterparty_id":{"type":"string"}}},"from":{"type":"object","properties":{"counterparty_id":{"type":"string"}}},"refund":{"type":"object","properties":{"reason_code":{"type":"string"},"transaction_id":{"type":"string"}}},"value":{"type":"object","properties":{"currency":{"type":"string"},"amount":{"type":"string"}}}}},"typed_success_response_body":{"type":"object","properties":{"type":{"type":"string"},"challenges":{"type":"array","items":{"type":"object","properties":{"challenge_type":{"type":"string"},"link":{"type":"string"},"id":{"type":"string"},"allowed_attempts":{"type":"integer"},"user_id":{"type":"string"}}}},"status":{"type":"string"},"end_date":{"type":"string","format":"date-time"},"charge":{"type":"object","properties":{"summary":{"type":"string"},"value":{"type":"object","properties":{"currency":{"type":"string"},"amount":{"type":"string"}}}}},"transaction_ids":{"type":"array","items":{"type":"string"}},"from":{"type":"object","properties":{"bank_id":{"type":"string"},"account_id":{"type":"string"}}},"details":{"type":"object","properties":{"description":{"type":"string"},"to_sandbox_tan":{"type":"object","properties":{"account_id":{"type":"string"},"bank_id":{"type":"string"}}},"value":{"type":"object","properties":{"currency":{"type":"string"},"amount":{"type":"string"}}},"to_transfer_to_phone":{"type":"object","properties":{"description":{"type":"string"},"message":{"type":"string"},"from":{"type":"object","properties":{"nickname":{"type":"string"},"mobile_phone_number":{"type":"string"}}},"to":{"type":"object","properties":{"mobile_phone_number":{"type":"string"}}},"value":{"type":"object","properties":{"currency":{"type":"string"},"amount":{"type":"string"}}}}},"to_sepa":{"type":"object","properties":{"iban":{"type":"string"}}},"to_simple":{"type":"object","properties":{"otherBankRoutingAddress":{"type":"string"},"otherAccountSecondaryRoutingAddress":{"type":"string"},"otherBranchRoutingScheme":{"type":"string"},"otherAccountRoutingScheme":{"type":"string"},"otherAccountRoutingAddress":{"type":"string"},"otherBankRoutingScheme":{"type":"string"},"otherBranchRoutingAddress":{"type":"string"},"otherAccountSecondaryRoutingScheme":{"type":"string"}}},"to_counterparty":{"type":"object","properties":{"counterparty_id":{"type":"string"}}},"to_transfer_to_account":{"type":"object","properties":{"to":{"type":"object","properties":{"name":{"type":"string"},"account":{"type":"object","properties":{"number":{"type":"string"},"iban":{"type":"string"}}},"bank_code":{"type":"string"},"branch_number":{"type":"string"}}},"transfer_type":{"type":"string"},"description":{"type":"string"},"future_date":{"type":"string"},"value":{"type":"object","properties":{"currency":{"type":"string"},"amount":{"type":"string"}}}}},"to_sepa_credit_transfers":{"type":"object","properties":{"instructedAmount":{"type":"object","properties":{"currency":{"type":"string"},"amount":{"type":"string"}}},"debtorAccount":{"type":"object","properties":{"iban":{"type":"string"}}},"creditorAccount":{"type":"object","properties":{"iban":{"type":"string"}}},"creditorName":{"type":"string"}}},"to_transfer_to_atm":{"type":"object","properties":{"description":{"type":"string"},"message":{"type":"string"},"from":{"type":"object","properties":{"nickname":{"type":"string"},"mobile_phone_number":{"type":"string"}}},"value":{"type":"object","properties":{"currency":{"type":"string"},"amount":{"type":"string"}}},"to":{"type":"object","properties":{"date_of_birth":{"type":"string"},"kyc_document":{"type":"object","properties":{"type":{"type":"string"},"number":{"type":"string"}}},"legal_name":{"type":"string"},"mobile_phone_number":{"type":"string"}}}}}}},"start_date":{"type":"string","format":"date-time"},"id":{"type":"string"}}},"is_featured":false,"special_instructions":"","specified_url":"/obp/v4.0.0/banks/BANK_ID/accounts/ACCOUNT_ID/VIEW_ID/transaction-request-types/REFUND/transaction-requests","connector_methods":[]},{"operation_id":"OBPv4.0.0-answerTransactionRequestChallenge","implemented_by":{"version":"OBPv4.0.0","function":"answerTransactionRequestChallenge"},"request_verb":"POST","request_url":"/obp/v4.0.0/banks/BANK_ID/accounts/ACCOUNT_ID/VIEW_ID/transaction-request-types/TRANSACTION_REQUEST_TYPE/transaction-requests/TRANSACTION_REQUEST_ID/challenge","summary":"Answer Transaction Request Challenge","description":"In Sandbox mode, any string that can be converted to a positive integer will be accepted as an answer.
\nThis endpoint totally depends on createTransactionRequest, it need get the following data from createTransactionRequest response body.
\n1)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.
\nFor instance: SANDBOX_TAN_OTP_INSTRUCTION_TRANSPORT=dummy
\nPossible values are dummy,email and sms
\nIn kafka mode, the answer can be got by phone message or other SCA methods.
Note that each Transaction Request Type can have its own OTP_INSTRUCTION_TRANSPORT method.
\nOTP_INSTRUCTION_TRANSPORT methods are set in Props. See sample.props.template for instructions.
Single or Multiple authorisations
\nOBP allows single or multi party authorisations.
\nSingle party authorisation:
\nIn 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
:
\nINITIATED => COMPLETED
Multiparty authorisation:
\nIn 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
:
\nINITIATED => 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.
\nRule for calculating number of security challenges:
\nIf Product Account attribute REQUIRED_CHALLENGE_ANSWERS=N then create N challenges
\n(one for every user that has a View where permission "can_add_transaction_request_to_any_account"=true)
\nIn the case REQUIRED_CHALLENGE_ANSWERS is not defined as an account attribute, the default number of security challenges created is one.
Authentication is Mandatory
\nURL Parameters:
\nACCOUNT_ID: 8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0
\nBANK_ID: gh.29.uk
\nTRANSACTION_REQUEST_ID: 8138a7e4-6d02-40e3-a129-0b2bf89de9f1
\nTRANSACTION_REQUEST_TYPE: SEPA
\nVIEW_ID: owner
\nJSON request body fields:
\n\nid: d8839721-ad8f-45dd-9f78-2080414b93f9
\nadditional_information: additional_information
\nreason_code: reason_code
\nJSON response body fields:
\n\naccount_id: 8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0
\n\namount: 10.12
\nbank_code: CGHZ
\nbank_id: gh.29.uk
\n\n\n\n\ncounterparty_id: 9fg8a7e4-6d02-40e3-a129-0b2bf89de8uh
\n\n\ncurrency: EUR
\ndate_of_birth: 2018-03-09
\n\ndescription: This an optional field. Maximum length is 2000. It can be any characters here.
\n\n\nfrom:
\nfuture_date: 20200127
\niban: DE91 1000 0000 0123 4567 89
\nid: d8839721-ad8f-45dd-9f78-2080414b93f9
\ninstructedAmount: 100
\n\nlegal_name: Eveline Tripman
\nmessage: 123456
\nmobile_phone_number: +49 30 901820
\nname: ACCOUNT_MANAGEMENT_FEE
\n\n\notherAccountRoutingAddress: otherAccountRoutingAddress
\notherAccountRoutingScheme: otherAccountRoutingScheme
\notherAccountSecondaryRoutingAddress: otherAccountSecondaryRoutingAddress
\notherAccountSecondaryRoutingScheme: otherAccountSecondaryRoutingScheme
\notherBankRoutingAddress: otherBankRoutingAddress
\notherBankRoutingScheme: otherBankRoutingScheme
\notherBranchRoutingAddress: otherBranchRoutingAddress
\notherBranchRoutingScheme: otherBranchRoutingScheme
\nstart_date: 2020-01-27
\n\n\nto:
\n\n\ntype:
\nvalue: 5987953
\n\n\n\n\nto_simple: to_simple
\n\n\n\n","description_markdown":"In Sandbox mode, any string that can be converted to a positive integer will be accepted as an answer.\n\nThis endpoint totally depends on createTransactionRequest, it need get the following data from createTransactionRequest response body.\n\n1)`TRANSACTION_REQUEST_TYPE` : is the same as createTransactionRequest request URL .\n\n2)`TRANSACTION_REQUEST_ID` : is the `id` field in createTransactionRequest response body.\n\n3) `id` : is `challenge.id` field in createTransactionRequest response body.\n\n4) `answer` : must be `123` in case that Strong Customer Authentication method for OTP challenge is dummy.\n For instance: SANDBOX_TAN_OTP_INSTRUCTION_TRANSPORT=dummy\n Possible values are dummy,email and sms\n In kafka mode, the answer can be got by phone message or other SCA methods.\n\nNote that each Transaction Request Type can have its own OTP_INSTRUCTION_TRANSPORT method.\nOTP_INSTRUCTION_TRANSPORT methods are set in Props. See sample.props.template for instructions.\n\nSingle or Multiple authorisations\n\nOBP allows single or multi party authorisations.\n\nSingle party authorisation:\n\nIn 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`:\n INITIATED => COMPLETED\n\n\nMultiparty authorisation:\n\nIn 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`:\n INITIATED => NEXT_CHALLENGE_PENDING => ... => NEXT_CHALLENGE_PENDING => COMPLETED\n\nThe 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.\n\nRule for calculating number of security challenges:\nIf Product Account attribute REQUIRED_CHALLENGE_ANSWERS=N then create N challenges\n(one for every user that has a View where permission \"can_add_transaction_request_to_any_account\"=true)\nIn the case REQUIRED_CHALLENGE_ANSWERS is not defined as an account attribute, the default number of security challenges created is one.\n\n \n\nAuthentication is Mandatory\n\n\n**URL Parameters:**\n\n[ACCOUNT_ID](/glossary#Account.account_id): 8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0\n\n\n\n[BANK_ID](/glossary#Bank.bank_id): gh.29.uk\n\n\n\n[TRANSACTION_REQUEST_ID](/glossary#): 8138a7e4-6d02-40e3-a129-0b2bf89de9f1\n\n\n\n[TRANSACTION_REQUEST_TYPE](/glossary#): SEPA\n\n\n\n[VIEW_ID](/glossary#this_view_id): owner\n\n\n\n\n\n**JSON request body fields:**\n\n\n\n[**answer**](/glossary#answer): \n\n\n\n[**id**](/glossary#id): d8839721-ad8f-45dd-9f78-2080414b93f9\n\n\n\n[additional_information](/glossary#): additional_information\n\n\n\n[reason_code](/glossary#): reason_code\n\n\n\n\n\n**JSON response body fields:**\n\n\n\n[**account**](/glossary#Account): \n\n\n\n[**account_id**](/glossary#): 8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0\n\n\n\n[**allowed_attempts**](/glossary#allowed_attempts): 5\n\n\n\n[**amount**](/glossary#): 10.12\n\n\n\n[**bank_code**](/glossary#bank_code): CGHZ\n\n\n\n[**bank_id**](/glossary#): gh.29.uk\n\n\n\n[**branch_number**](/glossary#branch_number): \n\n\n\n[**challenge**](/glossary#challenge): \n\n\n\n[**challenge_type**](/glossary#challenge_type): \n\n\n\n[**charge**](/glossary#charge): \n\n\n\n[**counterparty_id**](/glossary#): 9fg8a7e4-6d02-40e3-a129-0b2bf89de8uh\n\n\n\n[**creditorAccount**](/glossary#creditoraccount): \n\n\n\n[**creditorName**](/glossary#creditorname): \n\n\n\n[**currency**](/glossary#): EUR\n\n\n\n[**date_of_birth**](/glossary#): 2018-03-09\n\n\n\n[**debtorAccount**](/glossary#debtoraccount): \n\n\n\n[**description**](/glossary#description): This an optional field. Maximum length is 2000. It can be any characters here.\n\n\n\n[**details**](/glossary#details): \n\n\n\n[**end_date**](/glossary#end_date): \n\n\n\n[**from**](/glossary#from): \n\n\n\n[**future_date**](/glossary#future_date): 20200127\n\n\n\n[**iban**](/glossary#): DE91 1000 0000 0123 4567 89\n\n\n\n[**id**](/glossary#id): d8839721-ad8f-45dd-9f78-2080414b93f9\n\n\n\n[**instructedAmount**](/glossary#instructedamount): 100\n\n\n\n[**kyc_document**](/glossary#kyc_document): \n\n\n\n[**legal_name**](/glossary#): Eveline Tripman\n\n\n\n[**message**](/glossary#message): 123456\n\n\n\n[**mobile_phone_number**](/glossary#mobile_phone_number): +49 30 901820\n\n\n\n[**name**](/glossary#name): ACCOUNT_MANAGEMENT_FEE\n\n\n\n[**nickname**](/glossary#nickname): \n\n\n\n[**number**](/glossary#number): \n\n\n\n[**otherAccountRoutingAddress**](/glossary#): otherAccountRoutingAddress\n\n\n\n[**otherAccountRoutingScheme**](/glossary#): otherAccountRoutingScheme\n\n\n\n[**otherAccountSecondaryRoutingAddress**](/glossary#): otherAccountSecondaryRoutingAddress\n\n\n\n[**otherAccountSecondaryRoutingScheme**](/glossary#): otherAccountSecondaryRoutingScheme\n\n\n\n[**otherBankRoutingAddress**](/glossary#): otherBankRoutingAddress\n\n\n\n[**otherBankRoutingScheme**](/glossary#): otherBankRoutingScheme\n\n\n\n[**otherBranchRoutingAddress**](/glossary#): otherBranchRoutingAddress\n\n\n\n[**otherBranchRoutingScheme**](/glossary#): otherBranchRoutingScheme\n\n\n\n[**start_date**](/glossary#): 2020-01-27\n\n\n\n[**status**](/glossary#status): \n\n\n\n[**summary**](/glossary#summary): \n\n\n\n[**to**](/glossary#to): \n\n\n\n[**transaction_ids**](/glossary#transaction_ids): \n\n\n\n[**transfer_type**](/glossary#transfer_type): \n\n\n\n[**type**](/glossary#type): \n\n\n\n[**value**](/glossary#): 5987953\n\n\n\n[to_counterparty](/glossary#to_counterparty): \n\n\n\n[to_sandbox_tan](/glossary#to_sandbox_tan): \n\n\n\n[to_sepa](/glossary#to_sepa): \n\n\n\n[to_sepa_credit_transfers](/glossary#to_sepa_credit_transfers): \n\n\n\n[to_simple](/glossary#): to_simple\n\n\n\n[to_transfer_to_account](/glossary#to_transfer_to_account): \n\n\n\n[to_transfer_to_atm](/glossary#to_transfer_to_atm): \n\n\n\n[to_transfer_to_phone](/glossary#to_transfer_to_phone): \n\n\n","example_request_body":{"id":"This is challenge.id, you can get it from `Create Transaction Request.` response, only is useful if status ==`INITIATED` there.","answer":"123","reason_code":"[Optional] Reason code for REJECT answer (e.g. 'CUST')","additional_information":"[Optional] Additional description for REJECT answer"},"success_response_body":{"id":"4050046c-63b3-4868-8a22-14b4181d33a6","type":"SANDBOX_TAN","from":{"bank_id":"gh.29.uk","account_id":"8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0"},"details":{"to_sandbox_tan":{"bank_id":"String","account_id":"String"},"to_sepa":{"iban":"String"},"to_counterparty":{"counterparty_id":"9fg8a7e4-6d02-40e3-a129-0b2bf89de8uh"},"to_simple":{"otherBankRoutingScheme":"BIC","otherBankRoutingAddress":"GENODEM1GLS","otherBranchRoutingScheme":"BRANCH-CODE","otherBranchRoutingAddress":"DERBY6","otherAccountRoutingScheme":"IBAN","otherAccountRoutingAddress":"DE91 1000 0000 0123 4567 89","otherAccountSecondaryRoutingScheme":"IBAN","otherAccountSecondaryRoutingAddress":"DE91 1000 0000 0123 4567 89"},"to_transfer_to_phone":{"value":{"currency":"EUR","amount":"0"},"description":"String","message":"String","from":{"mobile_phone_number":"+44 07972 444 876","nickname":"String"},"to":{"mobile_phone_number":"+44 07972 444 876"}},"to_transfer_to_atm":{"value":{"currency":"EUR","amount":"0"},"description":"String","message":"String","from":{"mobile_phone_number":"+44 07972 444 876","nickname":"String"},"to":{"legal_name":"Eveline Tripman","date_of_birth":"20181230","mobile_phone_number":"+44 07972 444 876","kyc_document":{"type":"String","number":"String"}}},"to_transfer_to_account":{"value":{"currency":"EUR","amount":"0"},"description":"String","transfer_type":"String","future_date":"20181230","to":{"name":"String","bank_code":"String","branch_number":"String","account":{"number":"String","iban":"String"}}},"to_sepa_credit_transfers":{"debtorAccount":{"iban":"12345"},"instructedAmount":{"currency":"EUR","amount":"0"},"creditorAccount":{"iban":"54321"},"creditorName":"John Miles"},"value":{"currency":"EUR","amount":"100"},"description":"This an optional field. Maximum length is 2000. It can be any characters here."},"transaction_ids":["902ba3bb-dedd-45e7-9319-2fd3f2cd98a1"],"status":"COMPLETED","start_date":"1100-01-01T00:00:00Z","end_date":"1100-01-01T00:00:00Z","challenge":{"id":"be1a183d-b301-4b83-b855-5eeffdd3526f","allowed_attempts":3,"challenge_type":"SANDBOX_TAN"},"charge":{"summary":"Rent the flat","value":{"currency":"EUR","amount":"0"}}},"error_response_bodies":["OBP-20001: User not logged in. Authentication is required!","OBP-30111: Invalid Bank Id. The BANK_ID should only contain 0-9/a-z/A-Z/'-'/'.'/'_', the length should be smaller than 255.","OBP-30110: Invalid Account Id. The ACCOUNT_ID should only contain 0-9/a-z/A-Z/'-'/'.'/'_', the length should be smaller than 255.","OBP-10001: Incorrect json format.","OBP-30001: Bank not found. Please specify a valid value for BANK_ID.","OBP-30018: Bank Account not found. Please specify valid values for BANK_ID and ACCOUNT_ID. ","OBP-40011: Transaction Request Status is not INITIATED.","OBP-40009: The TRANSACTION_REQUEST_TYPE has changed.","OBP-40014: Sorry, you've used up your allowed attempts. ","OBP-00003: Transaction Requests is disabled in this API instance.","OBP-50000: Unknown Error."],"tags":["Transaction-Request","Payment Initiation Service (PIS)","PSD2"],"typed_request_body":{"type":"object","properties":{"additional_information":{"type":"string"},"answer":{"type":"string"},"reason_code":{"type":"string"},"id":{"type":"string"}}},"typed_success_response_body":{"type":"object","properties":{"type":{"type":"string"},"challenge":{"type":"object","properties":{"challenge_type":{"type":"string"},"allowed_attempts":{"type":"integer"},"id":{"type":"string"}}},"status":{"type":"string"},"end_date":{"type":"string","format":"date-time"},"charge":{"type":"object","properties":{"summary":{"type":"string"},"value":{"type":"object","properties":{"currency":{"type":"string"},"amount":{"type":"string"}}}}},"transaction_ids":{"type":"array","items":{"type":"string"}},"from":{"type":"object","properties":{"bank_id":{"type":"string"},"account_id":{"type":"string"}}},"details":{"type":"object","properties":{"description":{"type":"string"},"to_sandbox_tan":{"type":"object","properties":{"account_id":{"type":"string"},"bank_id":{"type":"string"}}},"value":{"type":"object","properties":{"currency":{"type":"string"},"amount":{"type":"string"}}},"to_transfer_to_phone":{"type":"object","properties":{"description":{"type":"string"},"message":{"type":"string"},"from":{"type":"object","properties":{"nickname":{"type":"string"},"mobile_phone_number":{"type":"string"}}},"to":{"type":"object","properties":{"mobile_phone_number":{"type":"string"}}},"value":{"type":"object","properties":{"currency":{"type":"string"},"amount":{"type":"string"}}}}},"to_sepa":{"type":"object","properties":{"iban":{"type":"string"}}},"to_simple":{"type":"object","properties":{"otherBankRoutingAddress":{"type":"string"},"otherAccountSecondaryRoutingAddress":{"type":"string"},"otherBranchRoutingScheme":{"type":"string"},"otherAccountRoutingScheme":{"type":"string"},"otherAccountRoutingAddress":{"type":"string"},"otherBankRoutingScheme":{"type":"string"},"otherBranchRoutingAddress":{"type":"string"},"otherAccountSecondaryRoutingScheme":{"type":"string"}}},"to_counterparty":{"type":"object","properties":{"counterparty_id":{"type":"string"}}},"to_transfer_to_account":{"type":"object","properties":{"to":{"type":"object","properties":{"name":{"type":"string"},"account":{"type":"object","properties":{"number":{"type":"string"},"iban":{"type":"string"}}},"bank_code":{"type":"string"},"branch_number":{"type":"string"}}},"transfer_type":{"type":"string"},"description":{"type":"string"},"future_date":{"type":"string"},"value":{"type":"object","properties":{"currency":{"type":"string"},"amount":{"type":"string"}}}}},"to_sepa_credit_transfers":{"type":"object","properties":{"instructedAmount":{"type":"object","properties":{"currency":{"type":"string"},"amount":{"type":"string"}}},"debtorAccount":{"type":"object","properties":{"iban":{"type":"string"}}},"creditorAccount":{"type":"object","properties":{"iban":{"type":"string"}}},"creditorName":{"type":"string"}}},"to_transfer_to_atm":{"type":"object","properties":{"description":{"type":"string"},"message":{"type":"string"},"from":{"type":"object","properties":{"nickname":{"type":"string"},"mobile_phone_number":{"type":"string"}}},"value":{"type":"object","properties":{"currency":{"type":"string"},"amount":{"type":"string"}}},"to":{"type":"object","properties":{"date_of_birth":{"type":"string"},"kyc_document":{"type":"object","properties":{"type":{"type":"string"},"number":{"type":"string"}}},"legal_name":{"type":"string"},"mobile_phone_number":{"type":"string"}}}}}}},"start_date":{"type":"string","format":"date-time"},"id":{"type":"string"}}},"is_featured":false,"special_instructions":"","specified_url":"/obp/v4.0.0/banks/BANK_ID/accounts/ACCOUNT_ID/VIEW_ID/transaction-request-types/TRANSACTION_REQUEST_TYPE/transaction-requests/TRANSACTION_REQUEST_ID/challenge","connector_methods":[]},{"operation_id":"OBPv4.0.0-createTransactionRequestSepa","implemented_by":{"version":"OBPv4.0.0","function":"createTransactionRequestSepa"},"request_verb":"POST","request_url":"/obp/v4.0.0/banks/BANK_ID/accounts/ACCOUNT_ID/VIEW_ID/transaction-request-types/SEPA/transaction-requests","summary":"Create Transaction Request (SEPA)","description":"Special instructions for SEPA:
\nWhen using a SEPA Transaction Request, you specify the IBAN of a Counterparty in the body of the request.
\nThe routing details (IBAN) of the counterparty will be forwarded to the core banking system for the transfer.
Initiate a Payment via creating a Transaction Request.
\nIn OBP, a transaction request
may or may not result in a transaction
. However, a transaction
only has one possible state: completed.
A Transaction Request
can have one of several states: INITIATED, NEXT_CHALLENGE_PENDING etc.
Transactions
are modeled on items in a bank statement that represent the movement of money.
Transaction Requests
are requests to move money which may or may not succeed and thus result in a Transaction
.
A Transaction Request
might create a security challenge that needs to be answered before the Transaction Request
proceeds.
\nIn case 1 person needs to answer security challenge we have next flow of state of an transaction request
:
\nINITIATED => COMPLETED
\nIn case n persons needs to answer security challenge we have next flow of state of an transaction request
:
\nINITIATED => NEXT_CHALLENGE_PENDING => ... => NEXT_CHALLENGE_PENDING => COMPLETED
The security challenge is bound to a user i.e. in case of right answer and the user is different than expected one the challenge will fail.
\nRule for calculating number of security challenges:
\nIf product Account attribute REQUIRED_CHALLENGE_ANSWERS=N then create N challenges
\n(one for every user that has a View where permission "can_add_transaction_request_to_any_account"=true)
\nIn case REQUIRED_CHALLENGE_ANSWERS is not defined as an account attribute default value is 1.
Transaction Requests contain charge information giving the client the opportunity to proceed or not (as long as the challenge level is appropriate).
\nTransaction Requests can have one of several Transaction Request Types which expect different bodies. The escaped body is returned in the details key of the GET response.
\nThis provides some commonality and one URL for many different payment or transfer types with enough flexibility to validate them differently.
The payer is set in the URL. Money comes out of the BANK_ID and ACCOUNT_ID specified in the URL.
\nIn sandbox mode, TRANSACTION_REQUEST_TYPE is commonly set to ACCOUNT. See getTransactionRequestTypesSupportedByBank for all supported types.
\nIn sandbox mode, if the amount is less than 1000 EUR (any currency, unless it is set differently on this server), the transaction request will create a transaction without a challenge, else the Transaction Request will be set to INITIALISED and a challenge will need to be answered.
\nIf a challenge is created you must answer it using Answer Transaction Request Challenge before the Transaction is created.
\nYou can transfer between different currency accounts. (new in 2.0.0). The currency in body must match the sending account.
\nThe following static FX rates are available in sandbox mode:
\n\nTransaction Requests satisfy PSD2 requirements thus:
\n1) A transaction can be initiated by a third party application.
\n2) The customer is informed of the charge that will incurred.
\n3) The call supports delegated authentication (OAuth)
\nSee this python code for a complete example of this flow.
\nThere is further documentation here
\nAuthentication is Mandatory
\nURL Parameters:
\nACCOUNT_ID: 8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0
\nBANK_ID: gh.29.uk
\nSEPA:
\nVIEW_ID: owner
\nJSON request body fields:
\namount: 10.12
\ncharge_policy: SHARED
\ncode: 125
\ncurrency: EUR
\ndescription: This an optional field. Maximum length is 2000. It can be any characters here.
\niban: DE91 1000 0000 0123 4567 89
\nto:
\nvalue: 5987953
\namount: 10.12
\ncurrency: EUR
\ndescription: This an optional field. Maximum length is 2000. It can be any characters here.
\n\nfuture_date: 20200127
\n\nJSON response body fields:
\n\naccount_id: 8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0
\n\namount: 10.12
\nbank_code: CGHZ
\nbank_id: gh.29.uk
\n\n\nchallenges: challenges
\n\ncounterparty_id: 9fg8a7e4-6d02-40e3-a129-0b2bf89de8uh
\n\n\ncurrency: EUR
\ndate_of_birth: 2018-03-09
\n\ndescription: This an optional field. Maximum length is 2000. It can be any characters here.
\n\n\nfrom:
\nfuture_date: 20200127
\niban: DE91 1000 0000 0123 4567 89
\nid: d8839721-ad8f-45dd-9f78-2080414b93f9
\ninstructedAmount: 100
\n\nlegal_name: Eveline Tripman
\nlink:
\nmessage: 123456
\nmobile_phone_number: +49 30 901820
\nname: ACCOUNT_MANAGEMENT_FEE
\n\n\notherAccountRoutingAddress: otherAccountRoutingAddress
\notherAccountRoutingScheme: otherAccountRoutingScheme
\notherAccountSecondaryRoutingAddress: otherAccountSecondaryRoutingAddress
\notherAccountSecondaryRoutingScheme: otherAccountSecondaryRoutingScheme
\notherBankRoutingAddress: otherBankRoutingAddress
\notherBankRoutingScheme: otherBankRoutingScheme
\notherBranchRoutingAddress: otherBranchRoutingAddress
\notherBranchRoutingScheme: otherBranchRoutingScheme
\nstart_date: 2020-01-27
\n\n\nto:
\n\n\ntype:
\nuser_id: 9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1
\nvalue: 5987953
\n\n\n\n\nto_simple: to_simple
\n\n\n\n","description_markdown":"Special instructions for SEPA:\n\nWhen using a SEPA Transaction Request, you specify the IBAN of a Counterparty in the body of the request.\nThe routing details (IBAN) of the counterparty will be forwarded to the core banking system for the transfer.\n\nInitiate a Payment via creating a Transaction Request.\n\nIn OBP, a `transaction request` may or may not result in a `transaction`. However, a `transaction` only has one possible state: completed.\n\nA `Transaction Request` can have one of several states: INITIATED, NEXT_CHALLENGE_PENDING etc.\n\n`Transactions` are modeled on items in a bank statement that represent the movement of money.\n\n`Transaction Requests` are requests to move money which may or may not succeed and thus result in a `Transaction`.\n\nA `Transaction Request` might create a security challenge that needs to be answered before the `Transaction Request` proceeds.\nIn case 1 person needs to answer security challenge we have next flow of state of an `transaction request`:\n INITIATED => COMPLETED\nIn case n persons needs to answer security challenge we have next flow of state of an `transaction request`:\n INITIATED => NEXT_CHALLENGE_PENDING => ... => NEXT_CHALLENGE_PENDING => COMPLETED\n\nThe security challenge is bound to a user i.e. in case of right answer and the user is different than expected one the challenge will fail.\n\nRule for calculating number of security challenges:\nIf product Account attribute REQUIRED_CHALLENGE_ANSWERS=N then create N challenges\n(one for every user that has a View where permission \"can_add_transaction_request_to_any_account\"=true)\nIn case REQUIRED_CHALLENGE_ANSWERS is not defined as an account attribute default value is 1.\n\nTransaction Requests contain charge information giving the client the opportunity to proceed or not (as long as the challenge level is appropriate).\n\nTransaction Requests can have one of several Transaction Request Types which expect different bodies. The escaped body is returned in the details key of the GET response.\nThis provides some commonality and one URL for many different payment or transfer types with enough flexibility to validate them differently.\n\nThe payer is set in the URL. Money comes out of the BANK_ID and ACCOUNT_ID specified in the URL.\n\nIn sandbox mode, TRANSACTION_REQUEST_TYPE is commonly set to ACCOUNT. See getTransactionRequestTypesSupportedByBank for all supported types.\n\nIn sandbox mode, if the amount is less than 1000 EUR (any currency, unless it is set differently on this server), the transaction request will create a transaction without a challenge, else the Transaction Request will be set to INITIALISED and a challenge will need to be answered.\n\nIf a challenge is created you must answer it using Answer Transaction Request Challenge before the Transaction is created.\n\nYou can transfer between different currency accounts. (new in 2.0.0). The currency in body must match the sending account.\n\nThe following static FX rates are available in sandbox mode:\n\nhttps://apiexplorer-ii-sandbox.openbankproject.com//more?version=OBPv4.0.0&list-all-banks=false&core=&psd2=&obwg=#OBPv2_2_0-getCurrentFxRate\n\n\nTransaction Requests satisfy PSD2 requirements thus:\n\n1) A transaction can be initiated by a third party application.\n\n2) The customer is informed of the charge that will incurred.\n\n3) The call supports delegated authentication (OAuth)\n\nSee [this python code](https://github.com/OpenBankProject/Hello-OBP-DirectLogin-Python/blob/master/hello_payments.py) for a complete example of this flow.\n\nThere is further documentation [here](https://github.com/OpenBankProject/OBP-API/wiki/Transaction-Requests)\n\n\n\n \n\nAuthentication is Mandatory\n\n\n**URL Parameters:**\n\n[ACCOUNT_ID](/glossary#Account.account_id): 8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0\n\n\n\n[BANK_ID](/glossary#Bank.bank_id): gh.29.uk\n\n\n\n[SEPA](/glossary#sepa): \n\n\n\n[VIEW_ID](/glossary#this_view_id): owner\n\n\n\n\n\n**JSON request body fields:**\n\n\n\n[**amount**](/glossary#): 10.12\n\n\n\n[**charge_policy**](/glossary#): SHARED\n\n\n\n[**code**](/glossary#code): 125\n\n\n\n[**currency**](/glossary#): EUR\n\n\n\n[**description**](/glossary#description): This an optional field. Maximum length is 2000. It can be any characters here.\n\n\n\n[**iban**](/glossary#): DE91 1000 0000 0123 4567 89\n\n\n\n[**to**](/glossary#to): \n\n\n\n[**value**](/glossary#): 5987953\n\n\n\n[**amount**](/glossary#): 10.12\n\n\n\n[**currency**](/glossary#): EUR\n\n\n\n[**description**](/glossary#description): This an optional field. Maximum length is 2000. It can be any characters here.\n\n\n\n[document_number](/glossary#document_number): \n\n\n\n[future_date](/glossary#future_date): 20200127\n\n\n\n[reasons](/glossary#reasons): \n\n\n\n\n\n**JSON response body fields:**\n\n\n\n[**account**](/glossary#Account): \n\n\n\n[**account_id**](/glossary#): 8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0\n\n\n\n[**allowed_attempts**](/glossary#allowed_attempts): 5\n\n\n\n[**amount**](/glossary#): 10.12\n\n\n\n[**bank_code**](/glossary#bank_code): CGHZ\n\n\n\n[**bank_id**](/glossary#): gh.29.uk\n\n\n\n[**branch_number**](/glossary#branch_number): \n\n\n\n[**challenge_type**](/glossary#challenge_type): \n\n\n\n[**challenges**](/glossary#): challenges\n\n\n\n[**charge**](/glossary#charge): \n\n\n\n[**counterparty_id**](/glossary#): 9fg8a7e4-6d02-40e3-a129-0b2bf89de8uh\n\n\n\n[**creditorAccount**](/glossary#creditoraccount): \n\n\n\n[**creditorName**](/glossary#creditorname): \n\n\n\n[**currency**](/glossary#): EUR\n\n\n\n[**date_of_birth**](/glossary#): 2018-03-09\n\n\n\n[**debtorAccount**](/glossary#debtoraccount): \n\n\n\n[**description**](/glossary#description): This an optional field. Maximum length is 2000. It can be any characters here.\n\n\n\n[**details**](/glossary#details): \n\n\n\n[**end_date**](/glossary#end_date): \n\n\n\n[**from**](/glossary#from): \n\n\n\n[**future_date**](/glossary#future_date): 20200127\n\n\n\n[**iban**](/glossary#): DE91 1000 0000 0123 4567 89\n\n\n\n[**id**](/glossary#id): d8839721-ad8f-45dd-9f78-2080414b93f9\n\n\n\n[**instructedAmount**](/glossary#instructedamount): 100\n\n\n\n[**kyc_document**](/glossary#kyc_document): \n\n\n\n[**legal_name**](/glossary#): Eveline Tripman\n\n\n\n[**link**](/glossary#link): \n\n\n\n[**message**](/glossary#message): 123456\n\n\n\n[**mobile_phone_number**](/glossary#mobile_phone_number): +49 30 901820\n\n\n\n[**name**](/glossary#name): ACCOUNT_MANAGEMENT_FEE\n\n\n\n[**nickname**](/glossary#nickname): \n\n\n\n[**number**](/glossary#number): \n\n\n\n[**otherAccountRoutingAddress**](/glossary#): otherAccountRoutingAddress\n\n\n\n[**otherAccountRoutingScheme**](/glossary#): otherAccountRoutingScheme\n\n\n\n[**otherAccountSecondaryRoutingAddress**](/glossary#): otherAccountSecondaryRoutingAddress\n\n\n\n[**otherAccountSecondaryRoutingScheme**](/glossary#): otherAccountSecondaryRoutingScheme\n\n\n\n[**otherBankRoutingAddress**](/glossary#): otherBankRoutingAddress\n\n\n\n[**otherBankRoutingScheme**](/glossary#): otherBankRoutingScheme\n\n\n\n[**otherBranchRoutingAddress**](/glossary#): otherBranchRoutingAddress\n\n\n\n[**otherBranchRoutingScheme**](/glossary#): otherBranchRoutingScheme\n\n\n\n[**start_date**](/glossary#): 2020-01-27\n\n\n\n[**status**](/glossary#status): \n\n\n\n[**summary**](/glossary#summary): \n\n\n\n[**to**](/glossary#to): \n\n\n\n[**transaction_ids**](/glossary#transaction_ids): \n\n\n\n[**transfer_type**](/glossary#transfer_type): \n\n\n\n[**type**](/glossary#type): \n\n\n\n[**user_id**](/glossary#): 9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1\n\n\n\n[**value**](/glossary#): 5987953\n\n\n\n[to_counterparty](/glossary#to_counterparty): \n\n\n\n[to_sandbox_tan](/glossary#to_sandbox_tan): \n\n\n\n[to_sepa](/glossary#to_sepa): \n\n\n\n[to_sepa_credit_transfers](/glossary#to_sepa_credit_transfers): \n\n\n\n[to_simple](/glossary#): to_simple\n\n\n\n[to_transfer_to_account](/glossary#to_transfer_to_account): \n\n\n\n[to_transfer_to_atm](/glossary#to_transfer_to_atm): \n\n\n\n[to_transfer_to_phone](/glossary#to_transfer_to_phone): \n\n\n","example_request_body":{"value":{"currency":"EUR","amount":"0"},"to":{"iban":"123"},"description":"This is a SEPA Transaction Request","charge_policy":"SHARED","future_date":"20200127","reasons":[{"code":"410","document_number":"2020/154","amount":"100","currency":"EUR","description":"SEPA payment"}]},"success_response_body":{"id":"4050046c-63b3-4868-8a22-14b4181d33a6","type":"SANDBOX_TAN","from":{"bank_id":"gh.29.uk","account_id":"8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0"},"details":{"to_sandbox_tan":{"bank_id":"String","account_id":"String"},"to_sepa":{"iban":"String"},"to_counterparty":{"counterparty_id":"9fg8a7e4-6d02-40e3-a129-0b2bf89de8uh"},"to_simple":{"otherBankRoutingScheme":"BIC","otherBankRoutingAddress":"GENODEM1GLS","otherBranchRoutingScheme":"BRANCH-CODE","otherBranchRoutingAddress":"DERBY6","otherAccountRoutingScheme":"IBAN","otherAccountRoutingAddress":"DE91 1000 0000 0123 4567 89","otherAccountSecondaryRoutingScheme":"IBAN","otherAccountSecondaryRoutingAddress":"DE91 1000 0000 0123 4567 89"},"to_transfer_to_phone":{"value":{"currency":"EUR","amount":"0"},"description":"String","message":"String","from":{"mobile_phone_number":"+44 07972 444 876","nickname":"String"},"to":{"mobile_phone_number":"+44 07972 444 876"}},"to_transfer_to_atm":{"value":{"currency":"EUR","amount":"0"},"description":"String","message":"String","from":{"mobile_phone_number":"+44 07972 444 876","nickname":"String"},"to":{"legal_name":"Eveline Tripman","date_of_birth":"20181230","mobile_phone_number":"+44 07972 444 876","kyc_document":{"type":"String","number":"String"}}},"to_transfer_to_account":{"value":{"currency":"EUR","amount":"0"},"description":"String","transfer_type":"String","future_date":"20181230","to":{"name":"String","bank_code":"String","branch_number":"String","account":{"number":"String","iban":"String"}}},"to_sepa_credit_transfers":{"debtorAccount":{"iban":"12345"},"instructedAmount":{"currency":"EUR","amount":"0"},"creditorAccount":{"iban":"54321"},"creditorName":"John Miles"},"value":{"currency":"EUR","amount":"100"},"description":"This an optional field. Maximum length is 2000. It can be any characters here."},"transaction_ids":["902ba3bb-dedd-45e7-9319-2fd3f2cd98a1"],"status":"COMPLETED","start_date":"1100-01-01T00:00:00Z","end_date":"1100-01-01T00:00:00Z","challenges":[{"id":"2fg8a7e4-6d02-40e3-a129-0b2bf89de8ub","user_id":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1","allowed_attempts":3,"challenge_type":"OBP_TRANSACTION_REQUEST_CHALLENGE","link":"/obp/v4.0.0/banks/BANK_ID/accounts/ACCOUNT_ID/VIEW_ID/transaction-request-types/TRANSACTION_REQUEST_TYPE/transaction-requests/TRANSACTION_REQUEST_ID/challenge"}],"charge":{"summary":"Rent the flat","value":{"currency":"EUR","amount":"0"}}},"error_response_bodies":["OBP-20001: User not logged in. Authentication is required!","OBP-30111: Invalid Bank Id. The BANK_ID should only contain 0-9/a-z/A-Z/'-'/'.'/'_', the length should be smaller than 255.","OBP-30110: Invalid Account Id. The ACCOUNT_ID should only contain 0-9/a-z/A-Z/'-'/'.'/'_', the length should be smaller than 255.","OBP-10001: Incorrect json format.","OBP-30001: Bank not found. Please specify a valid value for BANK_ID.","OBP-30003: Account not found. Please specify a valid value for ACCOUNT_ID.","OBP-30018: Bank Account not found. Please specify valid values for BANK_ID and ACCOUNT_ID. ","OBP-40002: Insufficient authorisation to create TransactionRequest. The Transaction Request could not be created because the login user doesn't have access to the view of the from account or the consumer doesn't have the access to the view of the from account or the login user does not have the `CanCreateAnyTransactionRequest` role or the view does not have the permission canaddtransactionrequesttoanyaccount.","OBP-40001: Invalid value for TRANSACTION_REQUEST_TYPE","OBP-10001: Incorrect json format.","OBP-10002: Invalid Number. Could not convert value to a number.","OBP-40008: Can't send a payment with a value of 0 or less.","OBP-40003: Transaction Request Currency must be the same as From Account Currency.","OBP-00003: Transaction Requests is disabled in this API instance.","OBP-50000: Unknown Error."],"tags":["Transaction-Request","Payment Initiation Service (PIS)","PSD2"],"typed_request_body":{"type":"object","properties":{"future_date":{"type":"string"},"reasons":{"type":"array","items":{"type":"object","properties":{"description":{"type":"string"},"code":{"type":"string"},"amount":{"type":"string"},"document_number":{"type":"string"},"currency":{"type":"string"}}}},"to":{"type":"object","properties":{"iban":{"type":"string"}}},"description":{"type":"string"},"value":{"type":"object","properties":{"currency":{"type":"string"},"amount":{"type":"string"}}},"charge_policy":{"type":"string"}}},"typed_success_response_body":{"type":"object","properties":{"type":{"type":"string"},"challenges":{"type":"array","items":{"type":"object","properties":{"challenge_type":{"type":"string"},"link":{"type":"string"},"id":{"type":"string"},"allowed_attempts":{"type":"integer"},"user_id":{"type":"string"}}}},"status":{"type":"string"},"end_date":{"type":"string","format":"date-time"},"charge":{"type":"object","properties":{"summary":{"type":"string"},"value":{"type":"object","properties":{"currency":{"type":"string"},"amount":{"type":"string"}}}}},"transaction_ids":{"type":"array","items":{"type":"string"}},"from":{"type":"object","properties":{"bank_id":{"type":"string"},"account_id":{"type":"string"}}},"details":{"type":"object","properties":{"description":{"type":"string"},"to_sandbox_tan":{"type":"object","properties":{"account_id":{"type":"string"},"bank_id":{"type":"string"}}},"value":{"type":"object","properties":{"currency":{"type":"string"},"amount":{"type":"string"}}},"to_transfer_to_phone":{"type":"object","properties":{"description":{"type":"string"},"message":{"type":"string"},"from":{"type":"object","properties":{"nickname":{"type":"string"},"mobile_phone_number":{"type":"string"}}},"to":{"type":"object","properties":{"mobile_phone_number":{"type":"string"}}},"value":{"type":"object","properties":{"currency":{"type":"string"},"amount":{"type":"string"}}}}},"to_sepa":{"type":"object","properties":{"iban":{"type":"string"}}},"to_simple":{"type":"object","properties":{"otherBankRoutingAddress":{"type":"string"},"otherAccountSecondaryRoutingAddress":{"type":"string"},"otherBranchRoutingScheme":{"type":"string"},"otherAccountRoutingScheme":{"type":"string"},"otherAccountRoutingAddress":{"type":"string"},"otherBankRoutingScheme":{"type":"string"},"otherBranchRoutingAddress":{"type":"string"},"otherAccountSecondaryRoutingScheme":{"type":"string"}}},"to_counterparty":{"type":"object","properties":{"counterparty_id":{"type":"string"}}},"to_transfer_to_account":{"type":"object","properties":{"to":{"type":"object","properties":{"name":{"type":"string"},"account":{"type":"object","properties":{"number":{"type":"string"},"iban":{"type":"string"}}},"bank_code":{"type":"string"},"branch_number":{"type":"string"}}},"transfer_type":{"type":"string"},"description":{"type":"string"},"future_date":{"type":"string"},"value":{"type":"object","properties":{"currency":{"type":"string"},"amount":{"type":"string"}}}}},"to_sepa_credit_transfers":{"type":"object","properties":{"instructedAmount":{"type":"object","properties":{"currency":{"type":"string"},"amount":{"type":"string"}}},"debtorAccount":{"type":"object","properties":{"iban":{"type":"string"}}},"creditorAccount":{"type":"object","properties":{"iban":{"type":"string"}}},"creditorName":{"type":"string"}}},"to_transfer_to_atm":{"type":"object","properties":{"description":{"type":"string"},"message":{"type":"string"},"from":{"type":"object","properties":{"nickname":{"type":"string"},"mobile_phone_number":{"type":"string"}}},"value":{"type":"object","properties":{"currency":{"type":"string"},"amount":{"type":"string"}}},"to":{"type":"object","properties":{"date_of_birth":{"type":"string"},"kyc_document":{"type":"object","properties":{"type":{"type":"string"},"number":{"type":"string"}}},"legal_name":{"type":"string"},"mobile_phone_number":{"type":"string"}}}}}}},"start_date":{"type":"string","format":"date-time"},"id":{"type":"string"}}},"is_featured":false,"special_instructions":"","specified_url":"/obp/v4.0.0/banks/BANK_ID/accounts/ACCOUNT_ID/VIEW_ID/transaction-request-types/SEPA/transaction-requests","connector_methods":[]},{"operation_id":"OBPv4.0.0-createTransactionRequestSimple","implemented_by":{"version":"OBPv4.0.0","function":"createTransactionRequestSimple"},"request_verb":"POST","request_url":"/obp/v4.0.0/banks/BANK_ID/accounts/ACCOUNT_ID/VIEW_ID/transaction-request-types/SIMPLE/transaction-requests","summary":"Create Transaction Request (SIMPLE)","description":"Special instructions for SIMPLE:
\nYou can transfer money to the Bank Account Number or IBAN directly.
\nInitiate a Payment via creating a Transaction Request.
\nIn OBP, a transaction request
may or may not result in a transaction
. However, a transaction
only has one possible state: completed.
A Transaction Request
can have one of several states: INITIATED, NEXT_CHALLENGE_PENDING etc.
Transactions
are modeled on items in a bank statement that represent the movement of money.
Transaction Requests
are requests to move money which may or may not succeed and thus result in a Transaction
.
A Transaction Request
might create a security challenge that needs to be answered before the Transaction Request
proceeds.
\nIn case 1 person needs to answer security challenge we have next flow of state of an transaction request
:
\nINITIATED => COMPLETED
\nIn case n persons needs to answer security challenge we have next flow of state of an transaction request
:
\nINITIATED => NEXT_CHALLENGE_PENDING => ... => NEXT_CHALLENGE_PENDING => COMPLETED
The security challenge is bound to a user i.e. in case of right answer and the user is different than expected one the challenge will fail.
\nRule for calculating number of security challenges:
\nIf product Account attribute REQUIRED_CHALLENGE_ANSWERS=N then create N challenges
\n(one for every user that has a View where permission "can_add_transaction_request_to_any_account"=true)
\nIn case REQUIRED_CHALLENGE_ANSWERS is not defined as an account attribute default value is 1.
Transaction Requests contain charge information giving the client the opportunity to proceed or not (as long as the challenge level is appropriate).
\nTransaction Requests can have one of several Transaction Request Types which expect different bodies. The escaped body is returned in the details key of the GET response.
\nThis provides some commonality and one URL for many different payment or transfer types with enough flexibility to validate them differently.
The payer is set in the URL. Money comes out of the BANK_ID and ACCOUNT_ID specified in the URL.
\nIn sandbox mode, TRANSACTION_REQUEST_TYPE is commonly set to ACCOUNT. See getTransactionRequestTypesSupportedByBank for all supported types.
\nIn sandbox mode, if the amount is less than 1000 EUR (any currency, unless it is set differently on this server), the transaction request will create a transaction without a challenge, else the Transaction Request will be set to INITIALISED and a challenge will need to be answered.
\nIf a challenge is created you must answer it using Answer Transaction Request Challenge before the Transaction is created.
\nYou can transfer between different currency accounts. (new in 2.0.0). The currency in body must match the sending account.
\nThe following static FX rates are available in sandbox mode:
\n\nTransaction Requests satisfy PSD2 requirements thus:
\n1) A transaction can be initiated by a third party application.
\n2) The customer is informed of the charge that will incurred.
\n3) The call supports delegated authentication (OAuth)
\nSee this python code for a complete example of this flow.
\nThere is further documentation here
\nAuthentication is Mandatory
\nURL Parameters:
\nACCOUNT_ID: 8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0
\nBANK_ID: gh.29.uk
\nSIMPLE: SIMPLE
\nVIEW_ID: owner
\nJSON request body fields:
\namount: 10.12
\ncharge_policy: SHARED
\ncurrency: EUR
\ndescription: This an optional field. Maximum length is 2000. It can be any characters here.
\nname: ACCOUNT_MANAGEMENT_FEE
\nother_account_routing_address:
\n\nother_account_secondary_routing_address:
\nother_account_secondary_routing_scheme:
\n\n\n\n\nto:
\nvalue: 5987953
\nfuture_date: 20200127
\nJSON response body fields:
\n\naccount_id: 8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0
\n\namount: 10.12
\nbank_code: CGHZ
\nbank_id: gh.29.uk
\n\n\nchallenges: challenges
\n\ncounterparty_id: 9fg8a7e4-6d02-40e3-a129-0b2bf89de8uh
\n\n\ncurrency: EUR
\ndate_of_birth: 2018-03-09
\n\ndescription: This an optional field. Maximum length is 2000. It can be any characters here.
\n\n\nfrom:
\nfuture_date: 20200127
\niban: DE91 1000 0000 0123 4567 89
\nid: d8839721-ad8f-45dd-9f78-2080414b93f9
\ninstructedAmount: 100
\n\nlegal_name: Eveline Tripman
\nlink:
\nmessage: 123456
\nmobile_phone_number: +49 30 901820
\nname: ACCOUNT_MANAGEMENT_FEE
\n\n\notherAccountRoutingAddress: otherAccountRoutingAddress
\notherAccountRoutingScheme: otherAccountRoutingScheme
\notherAccountSecondaryRoutingAddress: otherAccountSecondaryRoutingAddress
\notherAccountSecondaryRoutingScheme: otherAccountSecondaryRoutingScheme
\notherBankRoutingAddress: otherBankRoutingAddress
\notherBankRoutingScheme: otherBankRoutingScheme
\notherBranchRoutingAddress: otherBranchRoutingAddress
\notherBranchRoutingScheme: otherBranchRoutingScheme
\nstart_date: 2020-01-27
\n\n\nto:
\n\n\ntype:
\nuser_id: 9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1
\nvalue: 5987953
\n\n\n\n\nto_simple: to_simple
\n\n\n\n","description_markdown":"Special instructions for SIMPLE:\n\nYou can transfer money to the Bank Account Number or IBAN directly.\n\nInitiate a Payment via creating a Transaction Request.\n\nIn OBP, a `transaction request` may or may not result in a `transaction`. However, a `transaction` only has one possible state: completed.\n\nA `Transaction Request` can have one of several states: INITIATED, NEXT_CHALLENGE_PENDING etc.\n\n`Transactions` are modeled on items in a bank statement that represent the movement of money.\n\n`Transaction Requests` are requests to move money which may or may not succeed and thus result in a `Transaction`.\n\nA `Transaction Request` might create a security challenge that needs to be answered before the `Transaction Request` proceeds.\nIn case 1 person needs to answer security challenge we have next flow of state of an `transaction request`:\n INITIATED => COMPLETED\nIn case n persons needs to answer security challenge we have next flow of state of an `transaction request`:\n INITIATED => NEXT_CHALLENGE_PENDING => ... => NEXT_CHALLENGE_PENDING => COMPLETED\n\nThe security challenge is bound to a user i.e. in case of right answer and the user is different than expected one the challenge will fail.\n\nRule for calculating number of security challenges:\nIf product Account attribute REQUIRED_CHALLENGE_ANSWERS=N then create N challenges\n(one for every user that has a View where permission \"can_add_transaction_request_to_any_account\"=true)\nIn case REQUIRED_CHALLENGE_ANSWERS is not defined as an account attribute default value is 1.\n\nTransaction Requests contain charge information giving the client the opportunity to proceed or not (as long as the challenge level is appropriate).\n\nTransaction Requests can have one of several Transaction Request Types which expect different bodies. The escaped body is returned in the details key of the GET response.\nThis provides some commonality and one URL for many different payment or transfer types with enough flexibility to validate them differently.\n\nThe payer is set in the URL. Money comes out of the BANK_ID and ACCOUNT_ID specified in the URL.\n\nIn sandbox mode, TRANSACTION_REQUEST_TYPE is commonly set to ACCOUNT. See getTransactionRequestTypesSupportedByBank for all supported types.\n\nIn sandbox mode, if the amount is less than 1000 EUR (any currency, unless it is set differently on this server), the transaction request will create a transaction without a challenge, else the Transaction Request will be set to INITIALISED and a challenge will need to be answered.\n\nIf a challenge is created you must answer it using Answer Transaction Request Challenge before the Transaction is created.\n\nYou can transfer between different currency accounts. (new in 2.0.0). The currency in body must match the sending account.\n\nThe following static FX rates are available in sandbox mode:\n\nhttps://apiexplorer-ii-sandbox.openbankproject.com//more?version=OBPv4.0.0&list-all-banks=false&core=&psd2=&obwg=#OBPv2_2_0-getCurrentFxRate\n\n\nTransaction Requests satisfy PSD2 requirements thus:\n\n1) A transaction can be initiated by a third party application.\n\n2) The customer is informed of the charge that will incurred.\n\n3) The call supports delegated authentication (OAuth)\n\nSee [this python code](https://github.com/OpenBankProject/Hello-OBP-DirectLogin-Python/blob/master/hello_payments.py) for a complete example of this flow.\n\nThere is further documentation [here](https://github.com/OpenBankProject/OBP-API/wiki/Transaction-Requests)\n\n\n\n \n\nAuthentication is Mandatory\n\n\n**URL Parameters:**\n\n[ACCOUNT_ID](/glossary#Account.account_id): 8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0\n\n\n\n[BANK_ID](/glossary#Bank.bank_id): gh.29.uk\n\n\n\n[SIMPLE](/glossary#): SIMPLE\n\n\n\n[VIEW_ID](/glossary#this_view_id): owner\n\n\n\n\n\n**JSON request body fields:**\n\n\n\n[**amount**](/glossary#): 10.12\n\n\n\n[**charge_policy**](/glossary#): SHARED\n\n\n\n[**currency**](/glossary#): EUR\n\n\n\n[**description**](/glossary#description): This an optional field. Maximum length is 2000. It can be any characters here.\n\n\n\n[**name**](/glossary#name): ACCOUNT_MANAGEMENT_FEE\n\n\n\n[**other_account_routing_address**](/glossary#other_account_routing_address): \n\n\n\n[**other_account_routing_scheme**](/glossary#other_account_routing_scheme): \n\n\n\n[**other_account_secondary_routing_address**](/glossary#other_account_secondary_routing_address): \n\n\n\n[**other_account_secondary_routing_scheme**](/glossary#other_account_secondary_routing_scheme): \n\n\n\n[**other_bank_routing_address**](/glossary#other_bank_routing_address): \n\n\n\n[**other_bank_routing_scheme**](/glossary#other_bank_routing_scheme): \n\n\n\n[**other_branch_routing_address**](/glossary#other_branch_routing_address): \n\n\n\n[**other_branch_routing_scheme**](/glossary#other_branch_routing_scheme): \n\n\n\n[**to**](/glossary#to): \n\n\n\n[**value**](/glossary#): 5987953\n\n\n\n[future_date](/glossary#future_date): 20200127\n\n\n\n\n\n**JSON response body fields:**\n\n\n\n[**account**](/glossary#Account): \n\n\n\n[**account_id**](/glossary#): 8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0\n\n\n\n[**allowed_attempts**](/glossary#allowed_attempts): 5\n\n\n\n[**amount**](/glossary#): 10.12\n\n\n\n[**bank_code**](/glossary#bank_code): CGHZ\n\n\n\n[**bank_id**](/glossary#): gh.29.uk\n\n\n\n[**branch_number**](/glossary#branch_number): \n\n\n\n[**challenge_type**](/glossary#challenge_type): \n\n\n\n[**challenges**](/glossary#): challenges\n\n\n\n[**charge**](/glossary#charge): \n\n\n\n[**counterparty_id**](/glossary#): 9fg8a7e4-6d02-40e3-a129-0b2bf89de8uh\n\n\n\n[**creditorAccount**](/glossary#creditoraccount): \n\n\n\n[**creditorName**](/glossary#creditorname): \n\n\n\n[**currency**](/glossary#): EUR\n\n\n\n[**date_of_birth**](/glossary#): 2018-03-09\n\n\n\n[**debtorAccount**](/glossary#debtoraccount): \n\n\n\n[**description**](/glossary#description): This an optional field. Maximum length is 2000. It can be any characters here.\n\n\n\n[**details**](/glossary#details): \n\n\n\n[**end_date**](/glossary#end_date): \n\n\n\n[**from**](/glossary#from): \n\n\n\n[**future_date**](/glossary#future_date): 20200127\n\n\n\n[**iban**](/glossary#): DE91 1000 0000 0123 4567 89\n\n\n\n[**id**](/glossary#id): d8839721-ad8f-45dd-9f78-2080414b93f9\n\n\n\n[**instructedAmount**](/glossary#instructedamount): 100\n\n\n\n[**kyc_document**](/glossary#kyc_document): \n\n\n\n[**legal_name**](/glossary#): Eveline Tripman\n\n\n\n[**link**](/glossary#link): \n\n\n\n[**message**](/glossary#message): 123456\n\n\n\n[**mobile_phone_number**](/glossary#mobile_phone_number): +49 30 901820\n\n\n\n[**name**](/glossary#name): ACCOUNT_MANAGEMENT_FEE\n\n\n\n[**nickname**](/glossary#nickname): \n\n\n\n[**number**](/glossary#number): \n\n\n\n[**otherAccountRoutingAddress**](/glossary#): otherAccountRoutingAddress\n\n\n\n[**otherAccountRoutingScheme**](/glossary#): otherAccountRoutingScheme\n\n\n\n[**otherAccountSecondaryRoutingAddress**](/glossary#): otherAccountSecondaryRoutingAddress\n\n\n\n[**otherAccountSecondaryRoutingScheme**](/glossary#): otherAccountSecondaryRoutingScheme\n\n\n\n[**otherBankRoutingAddress**](/glossary#): otherBankRoutingAddress\n\n\n\n[**otherBankRoutingScheme**](/glossary#): otherBankRoutingScheme\n\n\n\n[**otherBranchRoutingAddress**](/glossary#): otherBranchRoutingAddress\n\n\n\n[**otherBranchRoutingScheme**](/glossary#): otherBranchRoutingScheme\n\n\n\n[**start_date**](/glossary#): 2020-01-27\n\n\n\n[**status**](/glossary#status): \n\n\n\n[**summary**](/glossary#summary): \n\n\n\n[**to**](/glossary#to): \n\n\n\n[**transaction_ids**](/glossary#transaction_ids): \n\n\n\n[**transfer_type**](/glossary#transfer_type): \n\n\n\n[**type**](/glossary#type): \n\n\n\n[**user_id**](/glossary#): 9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1\n\n\n\n[**value**](/glossary#): 5987953\n\n\n\n[to_counterparty](/glossary#to_counterparty): \n\n\n\n[to_sandbox_tan](/glossary#to_sandbox_tan): \n\n\n\n[to_sepa](/glossary#to_sepa): \n\n\n\n[to_sepa_credit_transfers](/glossary#to_sepa_credit_transfers): \n\n\n\n[to_simple](/glossary#): to_simple\n\n\n\n[to_transfer_to_account](/glossary#to_transfer_to_account): \n\n\n\n[to_transfer_to_atm](/glossary#to_transfer_to_atm): \n\n\n\n[to_transfer_to_phone](/glossary#to_transfer_to_phone): \n\n\n","example_request_body":{"to":{"name":"John Smith Ltd.","description":"The piano lession-Invoice No:68","other_bank_routing_scheme":"OBP","other_bank_routing_address":"gh.29.uk","other_account_routing_scheme":"OBP","other_account_routing_address":"36f8a9e6-c2b1-407a-8bd0-421b7119307e","other_account_secondary_routing_scheme":"IBAN","other_account_secondary_routing_address":"DE89370400440532013000","other_branch_routing_scheme":"OBP","other_branch_routing_address":"12f8a9e6-c2b1-407a-8bd0-421b7119307e"},"value":{"currency":"EUR","amount":"0"},"description":"This an optional field. Maximum length is 2000. It can be any characters here.","charge_policy":"SHARED","future_date":"20200127"},"success_response_body":{"id":"4050046c-63b3-4868-8a22-14b4181d33a6","type":"SANDBOX_TAN","from":{"bank_id":"gh.29.uk","account_id":"8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0"},"details":{"to_sandbox_tan":{"bank_id":"String","account_id":"String"},"to_sepa":{"iban":"String"},"to_counterparty":{"counterparty_id":"9fg8a7e4-6d02-40e3-a129-0b2bf89de8uh"},"to_simple":{"otherBankRoutingScheme":"BIC","otherBankRoutingAddress":"GENODEM1GLS","otherBranchRoutingScheme":"BRANCH-CODE","otherBranchRoutingAddress":"DERBY6","otherAccountRoutingScheme":"IBAN","otherAccountRoutingAddress":"DE91 1000 0000 0123 4567 89","otherAccountSecondaryRoutingScheme":"IBAN","otherAccountSecondaryRoutingAddress":"DE91 1000 0000 0123 4567 89"},"to_transfer_to_phone":{"value":{"currency":"EUR","amount":"0"},"description":"String","message":"String","from":{"mobile_phone_number":"+44 07972 444 876","nickname":"String"},"to":{"mobile_phone_number":"+44 07972 444 876"}},"to_transfer_to_atm":{"value":{"currency":"EUR","amount":"0"},"description":"String","message":"String","from":{"mobile_phone_number":"+44 07972 444 876","nickname":"String"},"to":{"legal_name":"Eveline Tripman","date_of_birth":"20181230","mobile_phone_number":"+44 07972 444 876","kyc_document":{"type":"String","number":"String"}}},"to_transfer_to_account":{"value":{"currency":"EUR","amount":"0"},"description":"String","transfer_type":"String","future_date":"20181230","to":{"name":"String","bank_code":"String","branch_number":"String","account":{"number":"String","iban":"String"}}},"to_sepa_credit_transfers":{"debtorAccount":{"iban":"12345"},"instructedAmount":{"currency":"EUR","amount":"0"},"creditorAccount":{"iban":"54321"},"creditorName":"John Miles"},"value":{"currency":"EUR","amount":"100"},"description":"This an optional field. Maximum length is 2000. It can be any characters here."},"transaction_ids":["902ba3bb-dedd-45e7-9319-2fd3f2cd98a1"],"status":"COMPLETED","start_date":"1100-01-01T00:00:00Z","end_date":"1100-01-01T00:00:00Z","challenges":[{"id":"2fg8a7e4-6d02-40e3-a129-0b2bf89de8ub","user_id":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1","allowed_attempts":3,"challenge_type":"OBP_TRANSACTION_REQUEST_CHALLENGE","link":"/obp/v4.0.0/banks/BANK_ID/accounts/ACCOUNT_ID/VIEW_ID/transaction-request-types/TRANSACTION_REQUEST_TYPE/transaction-requests/TRANSACTION_REQUEST_ID/challenge"}],"charge":{"summary":"Rent the flat","value":{"currency":"EUR","amount":"0"}}},"error_response_bodies":["OBP-20001: User not logged in. Authentication is required!","OBP-30111: Invalid Bank Id. The BANK_ID should only contain 0-9/a-z/A-Z/'-'/'.'/'_', the length should be smaller than 255.","OBP-30110: Invalid Account Id. The ACCOUNT_ID should only contain 0-9/a-z/A-Z/'-'/'.'/'_', the length should be smaller than 255.","OBP-10001: Incorrect json format.","OBP-30001: Bank not found. Please specify a valid value for BANK_ID.","OBP-30003: Account not found. Please specify a valid value for ACCOUNT_ID.","OBP-30018: Bank Account not found. Please specify valid values for BANK_ID and ACCOUNT_ID. ","OBP-40002: Insufficient authorisation to create TransactionRequest. The Transaction Request could not be created because the login user doesn't have access to the view of the from account or the consumer doesn't have the access to the view of the from account or the login user does not have the `CanCreateAnyTransactionRequest` role or the view does not have the permission canaddtransactionrequesttoanyaccount.","OBP-40001: Invalid value for TRANSACTION_REQUEST_TYPE","OBP-10001: Incorrect json format.","OBP-10002: Invalid Number. Could not convert value to a number.","OBP-40008: Can't send a payment with a value of 0 or less.","OBP-40003: Transaction Request Currency must be the same as From Account Currency.","OBP-00003: Transaction Requests is disabled in this API instance.","OBP-50000: Unknown Error."],"tags":["Transaction-Request","Payment Initiation Service (PIS)","PSD2"],"typed_request_body":{"type":"object","properties":{"description":{"type":"string"},"future_date":{"type":"string"},"to":{"type":"object","properties":{"description":{"type":"string"},"other_bank_routing_scheme":{"type":"string"},"other_account_secondary_routing_address":{"type":"string"},"name":{"type":"string"},"other_bank_routing_address":{"type":"string"},"other_account_routing_address":{"type":"string"},"other_branch_routing_scheme":{"type":"string"},"other_account_secondary_routing_scheme":{"type":"string"},"other_account_routing_scheme":{"type":"string"},"other_branch_routing_address":{"type":"string"}}},"value":{"type":"object","properties":{"currency":{"type":"string"},"amount":{"type":"string"}}},"charge_policy":{"type":"string"}}},"typed_success_response_body":{"type":"object","properties":{"type":{"type":"string"},"challenges":{"type":"array","items":{"type":"object","properties":{"challenge_type":{"type":"string"},"link":{"type":"string"},"id":{"type":"string"},"allowed_attempts":{"type":"integer"},"user_id":{"type":"string"}}}},"status":{"type":"string"},"end_date":{"type":"string","format":"date-time"},"charge":{"type":"object","properties":{"summary":{"type":"string"},"value":{"type":"object","properties":{"currency":{"type":"string"},"amount":{"type":"string"}}}}},"transaction_ids":{"type":"array","items":{"type":"string"}},"from":{"type":"object","properties":{"bank_id":{"type":"string"},"account_id":{"type":"string"}}},"details":{"type":"object","properties":{"description":{"type":"string"},"to_sandbox_tan":{"type":"object","properties":{"account_id":{"type":"string"},"bank_id":{"type":"string"}}},"value":{"type":"object","properties":{"currency":{"type":"string"},"amount":{"type":"string"}}},"to_transfer_to_phone":{"type":"object","properties":{"description":{"type":"string"},"message":{"type":"string"},"from":{"type":"object","properties":{"nickname":{"type":"string"},"mobile_phone_number":{"type":"string"}}},"to":{"type":"object","properties":{"mobile_phone_number":{"type":"string"}}},"value":{"type":"object","properties":{"currency":{"type":"string"},"amount":{"type":"string"}}}}},"to_sepa":{"type":"object","properties":{"iban":{"type":"string"}}},"to_simple":{"type":"object","properties":{"otherBankRoutingAddress":{"type":"string"},"otherAccountSecondaryRoutingAddress":{"type":"string"},"otherBranchRoutingScheme":{"type":"string"},"otherAccountRoutingScheme":{"type":"string"},"otherAccountRoutingAddress":{"type":"string"},"otherBankRoutingScheme":{"type":"string"},"otherBranchRoutingAddress":{"type":"string"},"otherAccountSecondaryRoutingScheme":{"type":"string"}}},"to_counterparty":{"type":"object","properties":{"counterparty_id":{"type":"string"}}},"to_transfer_to_account":{"type":"object","properties":{"to":{"type":"object","properties":{"name":{"type":"string"},"account":{"type":"object","properties":{"number":{"type":"string"},"iban":{"type":"string"}}},"bank_code":{"type":"string"},"branch_number":{"type":"string"}}},"transfer_type":{"type":"string"},"description":{"type":"string"},"future_date":{"type":"string"},"value":{"type":"object","properties":{"currency":{"type":"string"},"amount":{"type":"string"}}}}},"to_sepa_credit_transfers":{"type":"object","properties":{"instructedAmount":{"type":"object","properties":{"currency":{"type":"string"},"amount":{"type":"string"}}},"debtorAccount":{"type":"object","properties":{"iban":{"type":"string"}}},"creditorAccount":{"type":"object","properties":{"iban":{"type":"string"}}},"creditorName":{"type":"string"}}},"to_transfer_to_atm":{"type":"object","properties":{"description":{"type":"string"},"message":{"type":"string"},"from":{"type":"object","properties":{"nickname":{"type":"string"},"mobile_phone_number":{"type":"string"}}},"value":{"type":"object","properties":{"currency":{"type":"string"},"amount":{"type":"string"}}},"to":{"type":"object","properties":{"date_of_birth":{"type":"string"},"kyc_document":{"type":"object","properties":{"type":{"type":"string"},"number":{"type":"string"}}},"legal_name":{"type":"string"},"mobile_phone_number":{"type":"string"}}}}}}},"start_date":{"type":"string","format":"date-time"},"id":{"type":"string"}}},"is_featured":false,"special_instructions":"","specified_url":"/obp/v4.0.0/banks/BANK_ID/accounts/ACCOUNT_ID/VIEW_ID/transaction-request-types/SIMPLE/transaction-requests","connector_methods":[]}]}