GET Term Deposit Registration

get https://example.com/termdeposit/web/TermDeposits/{Company}/{AccountType}/{AccountNumber}/Registration

Retrieve term deposit registered owners for a specific Company, Account Type and AccountNumber.

time	status	user agent
Retrieving recent requests…

Loading…

Responses

Response body

object

data

object

Company

string

The unique Company identifier associated to the Term Deposit Account. Field values are accessed through the System Administration specification endpoint GET /System/Companies.

AccountType

string

This field is equivalent to Product Type. Field values are accessed through the Term Deposits specification endpoint GET /System/TermDeposits/{Company}/AccountTypes.

AccountNumber

int64

The unique account identifier.

ShortName

string

length ≤ 25

The Short Name of the account.

Registration1

string

length ≤ 36

The Registration Details text.

Registration2

string

length ≤ 36

The Registration Details text.

Registration3

string

length ≤ 36

The Registration Details text.

ExternalAccount

string

length ≤ 20

The External Account Number of the agent. This field is available when the Term Deposit has an associated Agent. It is a mandatory field when the Term Deposit is a Nominee Term. If the Term Deposit is a Nominee term, additional functionality will relate the agent to the External Account and Related Clients.

ExternalOrder

string

length ≤ 20

The External Order Number from the Agent. This is only editable if the Term Deposit has an associated Agent.

ExternalId

string

length ≤ 20

The External ID Number from the Agent. This is only editable if the Term Deposit has an associated Agent.

DepositAccountType

string

The Deposit Account Type from the Agent. This is only editable and mandatory when the Term Deposit is a Nominee Term. Field values are accessed through the Term Deposits specification endpoint GET /System/TermDeposits/CDICAccountTypes.

LEI

string

length ≤ 20

The LEI of the Agent. This is only editable if the Term Deposit has an associated Agent.

401

User is not authorized for this operation

403

User does not have the authority to perform the requested action

500

An error occurred on the backend server

Language

Credentials

OAuth2


xxxxxxxxxx
1
curl --request GET \
2
     --url https://example.com/termdeposit/web/TermDeposits/Company/AccountType/AccountNumber/Registration \
3
     --header 'accept: application/json'


xxxxxxxxxx
16
 
1
{
2
  "data": {
3
    "Company": "PPF",
4
    "AccountType": "A",
5
    "AccountNumber": 1234567,
6
    "ShortName": "JohnorJaneSmith",
7
    "Registration1": "Testing Tester ITF",
8
    "Registration2": "John Smith and",
9
    "Registration3": "Jane Smith",
10
    "ExternalAccount": "123ABC",
11
    "ExternalOrder": "55555",
12
    "ExternalId": "ABCD1234",
13
    "DepositAccountType": "nreg",
14
    "LEI": "123ABC456DEF"
15
  }
16
}

200Term Deposit Registration Information was retrieved

400Unable to understand the request, due to invalid syntax

404The requested resource could not be found