...
| Name | Type | Description | Mandatory | Available from version |
|---|---|---|---|---|
| BrickId | Guid | Not used. | ||
| AccountNo | String | This is the account number of the SystemAccount which should receive the deposit. Example: 15654 | True | |
| Amount | Decimal | This is the amount which should be deposited into the account. Negative amount is not allowed. Example: 1000 | True | |
| CurrencyCode | String | This the ISO-currency code of the deposit. Example: SEK | True | |
| ExternalReference | String | This can be any combination of characters which is used by the sender to link information between BFS and external systems Example: 465465456 (as the transaction ID of the external system) If the deposit order is associated with an AllocationProfileId the resulting Trade Orders will receive this value for their ExternalReference as well. | ||
| OrderSettlementType | Enum | Order settlement type is only applicable for orders with the Internal execution interface. This property will be set on trade orders created from the linked allocation order. PAYMENT CONFIRMATION PRICE (Not supported) | 2.02 | |
| AllocationProfileId | Guid | A Linked allocation order is created where the cash will be allocated according to the allocation. Amount overrides Linked Amount | ||
| Linked AmountLinkedAmount | Decimal | The amount to be used in the allocation | ||
| TradeDate | Datetime? | The trade date of the transaction. If not provided trade date will be set to today's date. | 2.02 |
Outputs
| Name | Type | Description |
|---|---|---|
| batchId | GUID | This is the id of the batch of deposits which were created and this can be used by the external system as a bank transaction reference in order for BFS to map a physical deposit to which individual deposit orders which are included |
| BatchOrderNo | String | This is a string in number format which represents the BatchOrder |
| Orders | Array | This is an array where each item represents the individual deposit orders which were included in the batch deposit. The Array includes: ExternalReference (the external reference received from the requester) OrderId (this is the GUID order id of the deposit order in BFS) OrderNo (this is a string in number format which represents the OrderId) |
...