Filter inputs

Name	Type	Description	Mandatory	Available from version

Name	Type	Description	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. TransferReceiverTypeBankGiro - This transfer receiver type is used for BankGiro payments in Sweden. TransferReceiverTypeDirectBankDomestic - This transfer receiver type is used for making direct bank payment within the country of where you are located. TransferReceiverTypeDirectBankForeign - This transfer receiver type is used for making direct bank payment outside the country of where you are located. TransferReceiverTypePlusGiro - This transfer receiver type is used for PlusGiro payments in Sweden. TransferReceiverTypeSecurities - This transfer receiver type is used for transferring financial securities TransferReceiverTypeSecuritiesAccount - This transfer receiver type is used to represent an account with EuroClear or other clearing agency TransferReceiverTypeSettlementCounterParty - This transfer receiver type is used to represent an account with a settlement counterparty. For example, if a legal entity has an account with a brokerage firm that can receive securities and the securities are to be sent to a clearing agency like EuroClear the brokerage firm will have an account with EuroClear and that account is the SettlementCounterparty. TransferReceiverExtraInfoBicIban - This transfer receiver is used for withdrawals made using BIC and IBAN (also used for the new ISO 20022 format) TransferReceiverTypeNorwegianBankAccount - This transfer receiver is used for transfers through a Norwegian bank account TransferReceiverTypeNorwegianPostGiro - This transfer receiver is used for transfers through a Norwegian PostGiro TransferReceiverTypeAvtaleGiro - This transfer receiver is used for transfers through a Norwegian AvtaleGiro	TransferReceiverExtraInfoBicIban from 2023-06-28 TransferReceiverTypeNorwegianBankAccount TransferReceiverTypeNorwegianPostGiro from 2024-03-06 TransferReceiverTypeAvtaleGiro from 2024-03-20
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

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	The internal status of the TransferReceiver. It can be one of the following, Open, Removed, or Closed.	2.38
KID	string	A TransferReceiver of the type TransferReceiverTypeAvtaleGiro, will have the property KID.

Code examples

Raw xml

<?xml version="1.0" encoding="utf-8"?>
<soap:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
    <soap:Body>
        <GetTransferReceivers xmlns="http://tempuri.org/">
            <req>
                <Credentials>
                    <UserName>{{UserName}}</UserName>
                    <Password>{{Password}}</Password>
                </Credentials>
                <identify>{{Identify}}</identify>
                <Args>
                    <BrickIds>
                        <guid>026a6194-8bb2-464b-9b15-19d9f89ee2db</guid>
                    </BrickIds>
                </Args>
                <Fields>
                    <BrickId >true</BrickId>
                    <KID>true</KID>
                    <State>true</State>
                </Fields>
            </req>
        </GetTransferReceivers>
    </soap:Body>
</soap:Envelope>

C# - GetTransferReceiver

//Use the GetTransferReceiver method 
var client = new BFSServiceReference.bfsapiSoapClient();

var credentials = new BFSServiceReference.Credentials()
{
    UserName = bfsusername, //Username of administrative user in your instance of BFS
    Password = bfspassword, //Password of the administrative user in your instance of BFS
};

var persons = client.GetTransferReceivers(new BFSServiceReference.GetTransferReceiversRequest()
{
    Credentials = credentials,

    identify = bfsidentifier, //Identifier is a unique token for your instance of BFS  

    Args = new BFSServiceReference.GetTransferReceiversArgs()
    {
        TransferReceiverTypeKeys = new []
        {
			"DomesticBank"
        }

    },

    Fields = new BFSServiceReference.GetTransferReceiverFields()
    {
        BrickId = true,
        AccountNo = true,
        BIC = true,
        BankName = true,
        IBAN = true
    },
});

foreach (var c in persons.Result)
{
    Console.WriteLine(c.BrickId + "," + c.AccountNo + "," + c.BIC + "," + c.BankName + "," + c.IBAN);
}

Blog stream

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

BFS API

GetTransferReceiver

Filter inputs

Response rows (Array) inherits from EntityBase

Code examples

C# - GetTransferReceiver

Blog stream

Related pages