Page tree
Skip to end of metadata
Go to start of metadata

List EFT consents

Lists one or more EFT consents. Requires logged on user.

Request

GET: APIURL/autogiromedgivanden.xml?apikey=338934897438&id=1&personid=2

Parameters

Name

Value

Description

Date type

Default

companyid

companyid=4

Retrieves EFT consents for specified company and current user (or user specified by personid).

ID

 

Response

tag

exempel

format

förklaring

id

<id>23</id>

ID

Unique ID

payernumber

<payernumber>1111111111111111</payernumber>

String

EFT consent number, normally this is a Swedish personal number consisting of 12 numbers. I.e. 197012071234

personid

<personid>5</personid>

ID

Person ID

clearingnumber<clearingnumber>4444</clearingnumber>StringClearing number
accountnumber<accountnumber>4444444</accountnumber>StringAccount number

created

<created>2015-08-15</created>

Date

When the EFT consent was created

companyid<companyid>2</companyid>IDUnique ID for the company the EFT consent belongs to
companyname<companyname>Acme INC</companyname>StringThe company name

active

<active>true</active>

Boolean

If the EFT consent is active or not

bgcaction

<bgcaction>none</bgcaction>

String

Action, if any, for the EFT consent. Permitted actions are : 'add', 'modify', 'delete', 'none'

 

 

<autogiromedgivanden>
  <autogiromedgivande>
    <id>23</id>
    <payernumber>197012071234</payernumber>
    <personid>5</personid>
    <clearingnumber>4444</clearingnumber>
	<accountnumber>4444444</accountnumber>
	<created>2012-08-15</created>
	<companyid>2</companyid>
	<companyname>Bolag 1</companyname>
    <active>true</active>
    <bgcaction>none</bgcaction>
  </autogiromedgivande>
</autogiromedgivanden>

 

Create EFT consent

Creates an electronic funds transaction consent. Requires logged on user.

Request

POST: APIURL/autogiromedgivanden.xml?apikey=338934897438&personid=2&companyid=1&clearingnumber=1111&accountnumber=555555&bgcaction=add

Parameters 

Name

Value

Description

Datatype

Required

Default

personidpersonid=1The user to create the EFT consent for. Please note that the person may be required to have specific information in accordance with local banking regulations.IDX 

companyid

companyid=4

Retrieves an EFT consent for the logged on user owned by a specific company (or person specified by personid)

ID

X

 

clearingnumberclearingnumber=1111Clearing numberIntegerYes, if waitingForEmedgivande=true or not specified.  
accountnumberaccountnumber=555555Account numberIntegerYes, if waitingForEmedgivande=false or not specified 
bgcactionbgcaction=add

Specify an action for the EFT consent.
Possible actions:
'add' : The action "Create" specifies that the EFT consent will be automatically sent to the local banking authorities.
'none': The action "None" requires that the EFT consent must be manually sent to the local banking authorities.

String 'none'
waitingforemedgivandewaitingforemedgivande=true

Enables the ability to create an EFT consent without a clearing number and account number. The EFT consent will be activated when the customer sends a electronic consent through their internet banking service.

Boolean false

Response

The same as for listing the EFT consents

Modify EFT consent

Modifies an existing EFT consent. Requireds logged on user. It is permitted to modify the EFT consent with bgcaction set to 'none'.

Request

PUT: APIURL/autogiromedgivanden.xml?apikey=338934897438&id=1&personid=2&clearingnumber=1111&accountnumber=555555

Parameters 

Name

Values

Description

Data type

Required

Default

idid=1The ID of the EFT consent that will be modified.IDX 
personidpersonid=1The person the EFT consent is created for.IDX 
clearingnumberclearingnumber=1111Clearing numberIntegerX 
accountnumberaccountnumber=555555Account numberIntegerX 

Response

The same as the listing of the EFT consents

  • No labels