Dataset: Bank Account

Dataset name: ds_bank_account

Description

Details of a member's bank account

Fields in this dataset

Name	Field Name	Description	Field Type	Field Example
Account Name	field_ba_account_name	The members account name	text	Mr Joe Bloggs
Account Number	field_ba_account_number	The members account number	text	12345678
Bank Name	field_ba_bank_name	The name of the members bank	text	HSBC
Branch	field_ba_branch	The members branch name	text	Watford
Branch Address Country	field_ba_branch_country	The bank country	text	England
Branch Address County	field_ba_branch_county	The bank county	text	Essex
Branch Address PostCode	field_ba_branch_postcode	The bank postcode	text	NB1 1AZ
Branch Address Street	field_ba_branch_street	The bank street name and building name/ number	text	1 High Street
Branch Address Telephone	field_ba_branch_telephone	The bank telephone number	text	(44) 01234 123456
Branch Address Town	field_ba_branch_town	The bank town	text	Watford
Current Balance	field_ba_current_balance	The current balance on the account	currency	23.45
Date From	field_ba_date_from	The date the member opened the account	date	29222
Date To	field_ba_date_to	The date the member closed the account	date	29222
Overdraft Limit	field_ba_overdraft_limit	The overdraft limit on the account	currency	200
Sort Code	field_ba_sort_code	The sort code on the members account	text	xx-xx-xx
Type	field_ba_type	The type of bank account held by the member	text	Savings

---

Making an API request for this Dataset

Example Request to the Sandbox Server

http://sbx-api.mydex.org/api/pds/pds/UID.json
  ?key=KEY
  &api_key=API_KEY
  &con_id=CON_ID
  &source_type=connection
  &dataset=ds_bank_account

Replace the following with your own details: UID KEY, API_KEY and CON_ID.

Replace sbx-api with api when making a connection to a real member on the production server (must be authenticated).

To return the data in XML, change UID.json to UID.xml.

Example Response

A response to this API request will be structured as follows.

The connection's read/write permissions are listed for each field. All instances of an accessible dataset are indexed with instance_N notation from N=0.

{
  "1": {
    "id": "1",
    "field_ba_account_name": "Mr Joe Bloggs",
    "field_ba_account_number": "12345678",
    "field_ba_bank_name": "HSBC",
    "field_ba_branch": "Watford",
    "field_ba_branch_country": "England",
    "field_ba_branch_county": "Essex",
    "field_ba_branch_postcode": "NB1 1AZ",
    "field_ba_branch_street": "1 High Street",
    "field_ba_branch_telephone": "(44) 01234 123456",
    "field_ba_branch_town": "Watford",
    "field_ba_current_balance": "23.45",
    "field_ba_date_from": "29222",
    "field_ba_date_to": "29222",
    "field_ba_overdraft_limit": "200",
    "field_ba_sort_code": "xx-xx-xx",
    "field_ba_type": "Savings"
  }
}