CreateAutoGiroWithdrawalOrders

CreateAutoGiroWithdrawalOrders

Inputs (Array[] of AutoGiroWithdrawalOrder) inherits from EntityBase

Name

Type

Description

Mandatory

Available from version

Name

Type

Description

Mandatory

Available from version

BrickId

Guid

 Not used.

 

 2.20.1

Account

Guid

 This is the sytem Id of the Account which the withdrawal concerns.

 True

 2.20.1

Amount

decimal

 The amount that will be withdrawn (positive number) 

 True

 2.20.1

BusinessDate

DateTime

The business date of the AutoGiro withdrawal

True

2.20.1

 TransferReceiver

Guid

 The system Id of the transfer receiver that should be used by the AutoGiro transfer. The only allowed TransferReceiverType is AutoGiro

 True

 2.20.1

 ExternalReference

string

This can be any combination of characters which is used by the sender to link information between BFS and external systems

Example: 465465456 (as the transaction ID of the external system)

 

 2.20.1

Comment

string

A comment that you want the order to have

 

2.20.1

Response rows

Name

Type

Description

Available from version

Name

Type

Description

Available from version

Orders

Array

The BrickId (unique id) of the account type

 This is an array where each item represents the individual withdrawal orders which were created from the AutoGiro withdrawal request. The Array includes:

ExternalReference (the external reference received from the requester)

OrderId (this is the GUID order id of the withdrawal order in BFS)

OrderNo (this is a string in number format which represents the OrderId)

Code examples

 //Create two withdrawals with the AutoGIroWithdrawalOrder 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 response = client.CreateAutoGiroWithdrawalOrders(new BFSServiceReference.CreateAutoGiroWithdrawalOrderRequest() { Credentials = credentials, identify = bfsidentifier, //Identifier is a unique token for your instance of BFS Entities = new[] { new AutoGiroWithdrawalOrder() { Account = new Guid("0d442e5c-dfda-4980-bb88-a2fcf45021d3"), BusinessDate = DateTime.Today Amount = 1000, TransferReceiver = new Guid("28dcb516-1a64-42d6-a886-b83bde5e81bf"), ExternalReference = "56789" }, new AutoGiroWithdrawalOrder() { Account = new Guid("649de517-8ffe-45db-80dc-cbca95070aae"), BusinessDate = DateTime.Today Amount = 110, ExternalReference = "Test2", TransferReceiver = new Guid("28dcb516-1a64-42d6-a886-b83bde5e81bf") } } }); foreach (var c in response.Entities) { Console.WriteLine(c.AccountNo); }