Skip to content

Latest commit

 

History

History
24 lines (21 loc) · 5.7 KB

RequestSepaMoneyTransferParams.md

File metadata and controls

24 lines (21 loc) · 5.7 KB
Raw

# RequestSepaMoneyTransferParams

Properties

Name Type Description Notes
recipient_name string Name of the recipient. Note: Neither finAPI nor the involved bank servers are guaranteed to validate the recipient name. Even if the recipient name does not depict the actual registered account holder of the specified recipient account, the money transfer request might still be successful. This field is optional only when you pass a clearing account as the recipient. Otherwise, this field is required. [optional]
recipient_iban string IBAN of the recipient's account. This field is optional only when you pass a clearing account as the recipient. Otherwise, this field is required. [optional]
recipient_bic string BIC of the recipient's account. Note: This field is optional when you pass a clearing account as the recipient or if the bank connection of the account that you want to transfer money from supports the IBAN-Only money transfer. You can find this out via GET /bankConnections/<id>. If no BIC is given, finAPI will try to recognize it using the given recipientIban value (if it's given). And then if the result value is not empty, it will be used for the money transfer request independent of whether it is required or not (unless you pass a clearing account, in which case the value will always be ignored). [optional]
clearing_account_id string Identifier of a clearing account. If this field is set, then the fields 'recipientName', 'recipientIban' and 'recipientBic' will be ignored and the recipient account will be the specified clearing account. [optional]
end_to_end_id string End-To-End ID for the transfer transaction [optional]
amount float The amount to transfer. Must be a positive decimal number with at most two decimal places (e.g. 99.99)
purpose string The purpose of the transfer transaction [optional]
sepa_purpose_code string SEPA purpose code, according to ISO 20022, external codes set. [optional]
account_id int Identifier of the bank account that you want to transfer money from
store_secrets bool Whether to store the PIN. If the PIN is stored, it is not required to pass the PIN again when executing SEPA orders. Default value is 'false'. <br/><br/>NOTES:<br/> - before you set this field to true, please regard the 'pinsAreVolatile' flag of the bank connection that the account belongs to. Please note that volatile credentials will not be stored, even if provided, to enforce user involvement in the next communication with the bank;<br/> - this field is ignored in case when the user will need to use finAPI's Web Form. The user will be able to decide whether to store the PIN or not in the Web Form, depending on the 'storeSecretsAvailableInWebForm' setting (see Client Configuration). [optional] [default to false]
two_step_procedure_id string The bank-given ID of the two-step-procedure that should be used for the order. For a list of available two-step-procedures, see the corresponding bank connection (GET /bankConnections). If this field is not set, then the bank connection's default two-step-procedure will be used. Note that in this case, when the bank connection has no default two-step-procedure set, then the response of the service depends on whether you need to use finAPI's Web Form or not. If you need to use the Web Form, the user will be prompted to select the two-step-procedure within the Web Form. If you don't need to use the Web Form, then the service will return an error (passing a value for this field is required in this case). [optional]
execution_date string Execution date for the money transfer(s), in the format 'YYYY-MM-DD'. If not specified, then the current date will be used. [optional]
single_booking bool This field is only regarded when you pass multiple orders. It determines whether the orders should be processed by the bank as one collective booking (in case of 'false'), or as single bookings (in case of 'true'). Default value is 'false'. [optional] [default to false]
additional_money_transfers \OpenAPIAccess\Client\Model\SingleMoneyTransferRecipientData[] <strong>Type:</strong> SingleMoneyTransferRecipientData<br/> In case that you want to submit not just a single money transfer, but do a collective money transfer, use this field to pass a list of additional money transfer orders. The service will then pass a collective money transfer request to the bank, including both the money transfer specified on the top-level, as well as all money transfers specified in this list. The maximum count of money transfers that you can pass (in total) is 15000. Note that you should check the account's 'supportedOrders' field to find out whether or not it is supporting collective money transfers. [optional]
hide_transaction_details_in_web_form bool Whether the finAPI Web Form should hide transaction details when prompting the caller for the second factor. Default value is false. [optional] [default to false]
multi_step_authentication MultiStepAuthenticationCallback <strong>Type:</strong> MultiStepAuthenticationCallback<br/> Container for multi-step authentication data. Required when a previous service call initiated a multi-step authentication. [optional]

[Back to Model list] [Back to API list] [Back to README]