Dataset: Credit Card
Dataset name:
ds_credit_card
Description
Details of the member's credit cards.
Fields in this dataset
Name | Field Name | Description | Field Type | Field Example |
---|---|---|---|---|
Account Name |
field_cc_account_name
|
The members surname on the card | text | Jones |
Account Number |
field_cc_account_number
|
The account number | text | 12345678 |
Card Type |
field_cc_card_type
|
The type of credit card | text | VISA |
Contact Address Country |
field_cc_contact_country
|
The members contact country | text | England |
Contact Address County |
field_cc_contact_county
|
The members contact county | text | Essex |
Contact Address PostCode |
field_cc_contact_postcode
|
The members contact postcode | text | NB1 1AZ |
Contact Address Street |
field_cc_contact_street
|
The member contact house number and street name | text | 1 High Street |
Contact Address Telephone |
field_cc_contact_telephone
|
The members contact telephone number | text | (44) 01234 123456 |
Contact Address Town |
field_cc_contact_town
|
The members contact town | text | Watford |
Credit Limit |
field_cc_credit_limit
|
The credit limit | currency | 2000 |
Balance |
field_cc_current_balance
|
The current balance of the credit card | currency | 245.67 |
Date From |
field_cc_date_from
|
The date the member opened the account | date | 29222 |
Date To |
field_cc_date_to
|
The date the member closed the account | date | 29222 |
Supplier |
field_cc_supplier
|
The credit card supplier | text | HSBC |
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_credit_card
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 withinstance_N
notation from N=0.
{ "1": { "id": "1", "field_cc_account_name": "Jones", "field_cc_account_number": "12345678", "field_cc_card_type": "VISA", "field_cc_contact_country": "England", "field_cc_contact_county": "Essex", "field_cc_contact_postcode": "NB1 1AZ", "field_cc_contact_street": "1 High Street", "field_cc_contact_telephone": "(44) 01234 123456", "field_cc_contact_town": "Watford", "field_cc_credit_limit": "2000", "field_cc_current_balance": "245.67", "field_cc_date_from": "29222", "field_cc_date_to": "29222", "field_cc_supplier": "HSBC" } }