Date: Fri, 29 Mar 2024 15:21:19 +0000 (UTC) Message-ID: <923232647.7.1711725679797@df5584cfe8ae> Subject: Exported From Confluence MIME-Version: 1.0 Content-Type: multipart/related; boundary="----=_Part_6_1931178590.1711725679797" ------=_Part_6_1931178590.1711725679797 Content-Type: text/html; charset=UTF-8 Content-Transfer-Encoding: quoted-printable Content-Location: file:///C:/exported.html
An autogiro deposit or withdrawal can be reattempted several times if a = problem occurs (for example insufficient funds). The number of reattempts i= s specified by Bricknode and is 3 at the time of writing this article.
The property AutogiroOrderStatus can be "AutomaticOrder_Active" even if = the property AutoGiroResponseCode is 1 (Insufficient funds) if the maximum = number of reattempts has not been reached. Thus, if you want to find all Au= togiroOrders that have been rejected because of insufficient funds and wher= e no further reattempts will be made you should filter on AutogiroOrderStat= us =3D "AutomaticOrder_Rejected" and AutoGiroResponseCode =3D 1.
If you want to find all AutogiroOrders where attempts were made to withd= raw or deposit money where there were an insufficient funds error but where= more attempts will be made, you should filter on AutogiroOrderStatus =3D "= AutomaticOrder_Active" and AutoGiroResponseCode =3D 1.
Name |
Type |
Description |
Mandatory |
Available from version |
---|---|---|---|---|
BrickIds |
Guid[] |
Filter by array of BrickIds. BrickId is the internal id of an autogiro o= rder |
|
2.27.20201216 |
CreatedDateFrom |
DateTime? |
When used, both from date and to date should be provided in the request<=
br> |
|
2.27.20201216 |
CreatedDateTo |
DateTime? |
|
2.27.20201216 |
|
CurrencyCodes |
string[] |
The ISO-code of the currency in the order, for example "EUR" |
|
2.27.20201216 |
ExternalReference |
string[] |
The external reference that was set at the creation of the order |
|
2.27.20201216 |
BatchOrderIds |
Guid[] |
The BrickIds of the batch orders that the autogiro orders should be incl= uded within |
|
2.27.20201216 |
AccountIds |
Guid[] |
The BrickIds of accounts that the autogiro orders should be associated w= ith |
|
2.27.20201216 |
AutogiroOrderStatuses |
string[] |
The current state of the order. The states can be found in the back offi= ce GUI of BFS by navigating to SystemData=E2=86=92Workflows and then look a= t the workflow for this order type |
|
2.27.20201216 |
TransferReceiverIds |
Guid[] |
The BrickIds of the TransferReceiver that the order was associated with<= /p> |
|
2.27.20201216 |
SettlementDateFrom |
DateTime? |
When used, both from date and to date should be provided in the request<= /p> |
|
2.27.20201216 |
SettlementDateTo |
DateTime? |
|
2.27.20201216 |
|
TransferOrderTypeKeys |
string[] |
The type of autogiro order. Can be "AutoGiroTransferInOrder" or "AutoGir= oTransferOutOrder". At least one is required for results. |
true |
2.27.20201216 |
AutogiroOrderNumbers |
string[] |
The order numbers of the autogiro orders |
|
2.27.20201216 |
AutoGiroResponseCodes |
string[] |
The autogiro response codes (payment codes). A null value means that the= order has no response and has not been processed by the bank. The code "0" means "payment processed". Insufficient funds are returned = as "1", and code "2" is a lack of Autogiro connection (cancelled bank accou= nt). |
|
2.28 |
Name |
Type |
Description |
Available from version |
---|---|---|---|
BrickId |
Guid |
The BrickId of the order |
2.27.20201216 |
CreatedDate |
DateTime |
The timestamp of when the order was created |
2.27.20201216 |
SettlementDate |
DateTime |
The date of when the order was settled |
2.27.20201216 |
CashAmount |
decimal |
The amount of the order |
2.27.20201216 |
AutogiroOrderStatus |
string |
The current state of the order as described by the workflow |
2.27.20201216 |
CurrencyCode |
string |
The ISO-code of the currency in the order, for example "EUR" |
2.27.20201216 |
AutogiroOrderNumber |
string |
The order number of the autogiro order |
2.27.20201216 |
ExternalReference |
string |
The external reference that was set at the creation of the order |
2.27.20201216 |
AccountId |
Guid |
The BrickId of the associated accout for the order |
2.27.20201216 |
BatchOrderNumber |
string |
The order number of the associated batch order if the autogiro order is = associated to one |
2.27.20201216 |
TransferOrderTypeKey |
string |
Whether the autogiro order is incoming or outgoing |
2.27.20201216 |
TransferReceiverId |
Guid |
The BrickId of the associated TransferReceiver. |
2.28 |
AutoGiroResponseCode |
string |
The autogiro response code of the AutoGiro order. |
2.28 |
RecurringOrderTemplateIds |
Guid[] |
RecurringOrderTemplateIds for RecurringOrderTemplate related to Transfer= Order |
2.33 |