...
| Name | Type | Description | Mandatory | Available from version |
|---|---|---|---|---|
| BrickId | Guid | Not used. | ||
| AccountNo | String | This is the account number of the SystemAccount which the withdrawal concerns. Example: 15654 | True | |
| IsPercent | Bool | This defines if the number in Amount should be read as a percentage number or a currency number. | True | |
| Amount | Decimal | This is the amount which should be withdrawn from the account. Negative amount is not allowed. Example: 1000 | True | |
| CurrencyCode | String | This the ISO-currency code of the withdrawal. 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) | True | |
| TransferReceiver | Guid | The BFS-id of the TransferReceiver. From version 2.20.1 you will only be able to use transfer receivers of type BankGiro and DirectBankDomestic. From 2023-06-21 you can also use the type BicIban if you want to use ISO 20022 Payments. Read more here: ISO 20022 Debit Payments - Bricknode Knowledgebase - Confluence (atlassian.net) | True |
Outputs
| Name | Type | Description | Available from version |
|---|---|---|---|
| Orders | Array | This is an array where each item represents the individual withdrawal orders which were created from the withdrawal request. The Array includes: ExternalReference (the external reference received from the requester) OrderId (this is the GUID order id of the withdrawal order in BFS) OrderNo (this is a string in number format which represents the OrderId) |
...