GetTransferReceiver
Filter inputs
Name | Type | Description | Mandatory | Available from version |
---|---|---|---|---|
BrickIds | Guid[] | Filter by an array of BrickIds. BrickId is the internal id of a Transfer Receiver | ||
Persons | Guid[] | Filter by an array of Persons | ||
TransferReceiverTypeKeys | String[] | Filter by an array of TransferReceiverTypeKeys TransferReceiverTypeAutoGiro - This transfer receiver type is used for AutoGiro payments in Sweden. | TransferReceiverExtraInfoBicIban from 2023-06-28 | |
BatchOrders | bool | If orders for the TransferReceiver are allowed to be batched | ||
BankNames | String[] | Filter by the name of the bank entered for the TransferReceiver | 2.02.20160708 | |
CounterpartyBrickIds | Guid[] | If the transfer receiver type is one that involves transferring securities instead of cash there will be a reference to a LegalEntity who is acting as counterparty. The full information about the counterparty can be fetched using GetPersons with this value as the input for BrickId. | 2.02.20160722 | |
CounterpartyNames | String[] | If the transfer receiver type is one that involves transferring securities instead of cash there will be a reference to a LegalEntity who is acting as counterparty and this is the company name of that Legal Entity. | 2.02.20160722 | |
States | String[] | Filter on the State of the TransferReceiver. Possible values are: Admission_Active, Admission_PendingCancelConfirmation, Admission_Cancelled, Admission_PendingCreateConfirmation, Admission_Created, Admission_ToBeCancelled, Admission_Rejected |
Response rows (Array) inherits from EntityBase
Name | Type | Description | Available from version |
---|---|---|---|
BrickId | Guid | The BrickId of the TransferReceiver | |
Person | Guid | The Person owning the TransferReceiver | |
TransferReceiverTypeKey | String | The TransferReceiverType key | |
Name | String | The name of the external account | |
Comment | String | The external account comment | |
AccountNo | String | The account number of the external account | |
CounterPartyClearingNo | String | The counterparty clearing number | |
CounterPartyAccountNo | String | The counterparty account number | |
PayerNumber | String | The PayerNumber of the external account | |
IBAN | String | The international bank account number | |
BIC | String | The business identifier code | |
Batchorders | bool | If orders for the TransferReceiver are allowed to be batched | |
BankName | String | The name of the bank entered for the TransferReceiver | 2.02.20160708 |
CounterpartyBrickId | Guid | If the transfer receiver type is one that involves transferring securities instead of cash there will be a reference to a LegalEntity who is acting as counterparty. The full information about the counterparty can be fetched using GetPersons with this value as the input for BrickId. | 2.02.20160722 |
CounterpartyName | String | If the transfer receiver type is one that involves transferring securities instead of cash there will be a reference to a LegalEntity who is acting as counterparty and this is the company name of that Legal Entity. | 2.02.20160722 |
State | String | The state of the TransferReceiver (Admission_Cancelled, Admission_Created etc.) | |
BankGiroNumber | string | A TransferReceiver of the type TransferReceiverTypeBankGiro, will have the property BankGiroNumber. | 2.37 |
Status | string | If the TransferReceiver has been Removed or Closed this property will be populated. | 2.38 |
Code examples
Blog stream
Create a blog post to share news and announcements with your team and company.
Terms of License
Change Policy
© 2009 - 2023 Huddlestock Technologies AB All rights reserved