GetTransferOrders

Filter inputs (Array of GetTransferOrdersArg)

Name	Type	Description	Mandatory	Available from version

Name	Type	Description	Available from version
BrickIds	Guid[]	Filter by array of BrickIds. BrickId is the internal id of a deposit order
TransferOrderTypes	string[]	Filter by array of TransferOrderTypes
CreatedDateFrom	DateTime?	When used, both from date and to date should be provided in the request
CreatedDateTo	DateTime?
CurrencyCodes	string[]	The ISO-code of the currency in the order, for example "EUR"
ExternalReference	string[]	The external reference that was set at the creation of the order
BatchOrders	Guid[]	The BrickIds of a BatchOrder that is connected to the TransferOrder
Accounts	Guid[]	The BrickIds of accounts where the TransferOrder should be associated with
States	string[]	The current state of the order. The states can be found in the back office GUI of BFS by navigating to SystemData→Workflows and then look at the workflow for this order type
TransferReceiver	Guid[]	The BrickIds of the TransferReceiver that the order was associated with. This connection is more common when it comes to withdrawals but could be used for deposits as well
SettlementDateFrom	DateTime?	When used, both from date and to date should be provided in the request
SettlementDateTo	DateTime?
BusinessDateFrom	DateTime?	When used, both from date and to date should be provided in the request
BusinessDateTo	DateTime?
RetryAttemptsFrom	Integer?	How many times the Transfer Order has went from Active to Placed.	IN DEVELOPMENT
RetryAttemptsTo	Integer?		IN DEVELOPMENT

See the Response row to see which properties that you would like to get.

Name	Type	Description	Available from version

Name	Type	Description	Available from version
BrickId	Guid	The BrickId of the order
CreatedDate	DateTime	The timestamp of when the order was created
SettlementDate	DateTime	The date of when the order was settled
CashAmount	decimal	The amount of the order
State	string	The current state of the order as described by the workflow
CurrencyCode	string	The ISO code of the currency in the order, for example, "EUR"
OrderNo	string	The order number of the deposit order
ExternalReference	string	The external reference that was set at the creation of the order
Account	Guid	The BrickId of the associated account for the order
TransferOrderType	string	The name of the order type
BatchOrderNo	string	The order number of the associated batch order if the withdrawal transfer order is associated to one
TransferReceiver	Guid	The BrickId of the TransferReceiver
BusinessDate	DateTime	The due date of the Transfer to happen
RetryAttempts	Integer	How many times the Transfer Order gone from Active to Placed.	2024-09-25

Create a blog post to share news and announcements with your team and company.