Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

Inputs (Array[]) inherits from EntityBase

Name

Type

Description

Mandatory

Available from version

Name

string

 Name of this transfer receiver

 True

 2.13

Comment

string

 A comment or description

 False


BatchOrders

bool

 True if orders on this account should be batch processed 

 True


Person

Guid

 The ID of the person who owns this account

 True


TransferReceiverExtraInfo

Complex

 Determines the account type. Also contains a type specific payload (spec below). One of the following:

  • TransferReceiverExtraInfoAutoGiro

  • TransferReceiverExtraInfoBankGiro

  • TransferReceiverExtraInfoDirectBankDomestic

  • TransferReceiverExtraInfoDirectBankForeign

  • TransferReceiverExtraInfoSecurities

  • TransferReceiverExtraInfoSecuritiesAccount

  • TransferReceiverExtraInfoPlusGiro

  • TransferReceiverExtraInfoBicIban

  • TransferReceiverExtraInfoNorwegianPostGiro

  • TransferReceiverExtraInfoNorwegianBankAccount

  • TransferReceiverExtraInfoAvtaleGiro

 True

TransferReceiverExtraInfoBicIban new from 2023-06-28

TransferReceiverExtraInfoNorwegianPostGiro
TransferReceiverExtraInfoNorwegianBankAccount new from 2024-03-06

TransferReceiverExtraInfoAvtaleGiro new from 2024-03-20

TransferReceiverExtraInfoAutoGiro

Name

Type

Description

Mandatory

Available from version

Comment

BankName

string

Name of the bank that holds the external account

False



CounterPartyClearingNo

string

Accounts clearing number 

True


Max five digits (a hyphen is not allowed)

CounterPartyAccountNo

string

Accounts account number

True



TransferReceiverExtraInfoBankGiro

Name

Type

Description

Mandatory

Available from version

Comment

Account No

string

External account number

False


Deprecated as of 2.37 and replaced by BankGiroNumber

BankGiroNumber

string

The BankGiro number.

True

2.37


TransferReceiverExtraInfoDirectBankDomestic

Name

Type

Description

Mandatory

Available from version

CounterPartyClearingNo

string

Accounts clearing number

True


CounterPartyAccountNo

string

Accounts account number

True


TransferReceiverExtraInfoDirectBankForeign

Name

Type

Description

Mandatory

Available from version

BIC

string

International BIC code

False


IBAN

string

International IBAN code

False


Address

string

The banks address 

False


TransferReceiverExtraInfoSecurities

Name

Type

Description

Mandatory

Available from version

CounterParty

string

Bricknode ID of the counterparty

True


AccountNo

string

Account number at the counterparty

False


TransferReceiverExtraInfoSecuritiesAccount

Name

Type

Description

Mandatory

Available from version

CounterParty

string

Bricknode ID of the counterparty

True


AccountNo

string

Account number at the counterparty

False


TransferReceiverExtraInfoPlusGiro

Name

Type

Description

Mandatory

Available from version

AccountNo

string

The plusgiro account number

False


TransferReceiverExtraInfoBicIban

Name

Type

Description

Mandatory

Available from version

BIC

string

BIC number

True

2023-06-28

IBAN

string

IBAN number

True

2023-06-28

TransferReceiverExtraInfoNorwegianPostGiro

Name

Type

Description

Mandatory

Available from version

AccountNo

string

The account number

true

2024-03-06

TransferReceiverExtraInfoNorwegianBankAccount

Name

Type

Description

Mandatory

Available from version

AccountNo

string

The account number

true

2024-03-06

BankName

string

The bank name

true

2024-03-06

TransferReceiverExtraInfoAvtaleGiro

Name

Type

Description

Mandatory

Available from version

AccountNo

string

The account number

true

2024-03-20

BankName

string

The bank name

false

2024-03-20

KID

string

Set your own KID if you have an active KID. If KID is empty or no value, the system will create a new KID and start the process to send to NETS.

KID should be unique in the system, so you cannot set a KID that already exist on an active Avtalegiro transferReceiver.

false

2024-08-28

Response rows

Name

Type

Description

Available from version

Entities

Array

All TransferReceivers in the request is returned. And array of Errors

per TransferReceiver

per TransferReceiver


Code examples

...

C# - Create an AutoGiro TransferReceiver
linenumbers
Code Block
true
languagecollapsetruec#
var request = new bfsapi.CreateTransferReceiversRequest()
{
	Credentials = new bfsapi.Credentials
    {
		UserName = "APIUSer",
		Password = "thesecret"
    },
    identify = "theIdentity",
};

request.Entities = new bfsapi.TransferReceiver[]
{
	new bfsapi.TransferReceiver()
	{
		Name = "TheAG account",
        Comment = "A very interesting comment",
        BatchOrders = false,
        Person = new Guid("d9ed44e3-b001-4e39-9a64-0421e0f310ed"),
		TransferReceiverExtraInfo = new TransferReceiverExtraInfoAutoGiro()
        {
        	BankName = "SEB",
        	CounterPartyClearingNo = "1234",
        	CounterPartyAccountNo = "1234",
        }
	}
};

var response = bfsapiClient.CreateTransferReceivers(request);

Postman:

Postman
Code Block
languagexml
<?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>
        <CreateTransferReceivers xmlns="http://tempuri.org/">
            <req>
                <Credentials>
                    <UserName>{{UserName}}</UserName>
                    <Password>{{Password}}</Password>
                </Credentials>
                <identify>{{Identify}}</identify>
                <Entities>
                    <TransferReceiver>
                        <Person>39ecba5f-b07f-4e8f-a74d-9e50d5016407</Person>
                        <Name>MyBicIbanExternalAccount</Name>
                            <TransferReceiverExtraInfo xsi:type="TransferReceiverExtraInfoBicIban">
                                <BIC>ESSESESS</BIC>
                                <IBAN>SE4550000000058398257466</IBAN>
                        </TransferReceiverExtraInfo>
                    </TransferReceiver>
                </Entities>
            </req>
        </CreateTransferReceivers>
    </soap:Body>
</soap:Envelope>