Skip to content

Latest commit

 

History

History
15 lines (12 loc) · 3.68 KB

CreateMoneyTransferParams.md

File metadata and controls

15 lines (12 loc) · 3.68 KB

# CreateMoneyTransferParams

Properties

Name Type Description Notes
account_id int Identifier of the account that should be used for the order. If you want to do a standalone order (finAPI Payment product, i.e. for an account that is not imported in finAPI) leave this field unset and instead use the fields <code>iban</code> and <code>bankId</code>. [optional]
iban string IBAN of the account that should be used for the order. Use this field only if you want to do a standalone order (finAPI Payment product, i.e. for an account that is not imported in finAPI). Otherwise, use the <code>accountId</code> field and leave this field unset. [optional]
bank_id int Identifier of the bank that should be used. Use this field only if you want to do a standalone order (finAPI Payment product, i.e. for an account that is not imported in finAPI) and when the <code>iban</code> is not sufficient to uniquely identify the bank (a bank search for the IBAN via <code>GET /banks?search=[IBAN]</code> returns multiple banks). If the IBAN uniquely identifies the bank, you may leave this field unset. Also, leave the field unset for non-standalone orders (using the <code>accountId</code> field). [optional]
execution_date \DateTime <strong>Format:</strong> 'YYYY-MM-DD'<br/>Execution date for the money transfer(s). May not be in the past. For instant payments, it must either be omitted, or be the current date. If not specified, most banks will use the current date as the instructed date for execution. [optional]
money_transfers \OpenAPI\Client\Model\MoneyTransferOrderParams[] List of money transfer orders (may contain at most 15000 items). Please note that collective money transfer may not always be supported.<br/>Bank-specific constraints may apply to this field. Please refer to BankInterface.paymentConstraints to make sure the payment you are creating won't get rejected.<br/> <strong>Type:</strong> MoneyTransferOrderParams
instant_payment bool Whether the order should be submitted to the bank as an instant SEPA order. Default value is 'false'.<br/><br/>NOTE:<br/>&bull; Instant payments can only be submitted if you are self-licensed (and not using the finAPI Web Form) OR via our Web Form from the endpoint <a href='?product=web_form_2.0#tag--Payment-Initiation-Services' target='_blank'>here</a>.<br/>&bull; Submitting an instant payment will work only with interfaces that support it, see BankInterface.paymentCapabilities.sepaInstantMoneyTransfer<br/>&bull; Instant payments work only for a single order, not for collective orders.<br/>&bull; The bank may charge a fee for instant payments, depending on the agreement between the user and the bank.<br/>&bull; The payment might get rejected if the source and/or target account doesn't support instant payments. [optional] [default to false]
single_booking bool This field is only relevant 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'). Note that it is subject to the bank whether it will regard the field. Default value is 'false'. [optional] [default to false]

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