Create a term deposit

post https://example.com/termdeposit/web/TermDeposits

Create a new term deposit in active status.

Body Params

Company

string

required

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

Branch

string

required

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

AgentNumber

int64

The Agent Number affiliated with the Term Deposit. Field values are accessed through the Agent Management specification endpoint GET /Agents/Profiles.

ClientNumber

int64

required

The unique Portfolio+ Client identifier. Field values are accessed through the Client Management specification endpoint GET /Clients/Profile.

AccountType

string

required

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

BankCode

string

The Company Bank Code for the term Deposit. Field values are accessed through the System Administration specification endpoint GET /System/Companies/{Company}/BankAccounts.

OwnerType

string

The Term Deposit Ownership Type. Field values are accessed through the Term Deposits specification endpoint GET /System/TermDeposits/OwnershipTypes.

PlanCompany

string

The Company Code of the Investment Plan for the CIF. Field values are accessed through the System Administration specification endpoint GET /System/Companies.

PlanNumber

int64

The Investment Plan Number for the CIF. Field values are accessed through the Investment specification endpoint GET /Investments/{Company}.

PurchaseMethod

string

Field values are accessed through the Term Deposits specification endpoint GET /System/TermDeposits/PurchaseMethods.

IssueDate

date

The Date the Term deposit was issued.

TermMonths

int32

The Term Deposit duration in months. This value is calculated if MaturityDate is specified.

TermDays

int32

The Term Deposit duration in number of days. This value is calculated if MaturityDate is specified.

MaturityDate

date

The Term Deposit Maturity Date. This value is calculated if TermMonths or TermDays are specified.

IsCompounded

boolean

Indicates if the Term Deposit compounds interest or not.

CompoundFrequency

string

The Term Deposit Compound Frequency. Field values are accessed through the Term Deposits specification endpoint GET /System/TermDeposits/CompoundFrequencies.

Principal

number

required

The Term Deposit Principal Amount.

PrincipalExceptionCode

string

The Principal Amount Exception Code if the Principal Amount is outside of the Product's defined minimum to maximum range. Field values are accessed through the Term Deposits specification endpoint GET /System/TermDeposits/PrincipalExceptions.

PaymentFrequency

string

The Term Deposit Payment Frequency. Field values are accessed through the Term Deposits specification endpoint GET /System/TermDeposits/PaymentFrequencies.

Rate

number

The Term Deposit Interest Rate. Field values are accessed through the Term Deposits specification endpoint GET /System/InterestRates/TermDeposits/{Company}.

RateExceptionCode

string

The Rate Exception Code if the rate changes from the Default Rate. Field values are accessed through the Term Deposits specification endpoint GET /System/TermDeposits/RateExceptions.

PayMode

string

The Payment Mode of the Term Deposit. Field values are accessed through the Term Deposits specification endpoint GET /System/TermDeposits/PayModes.

CombineCheque

boolean

Indicates if Principal and Interest payments combined into one cheque or not.

NonResidentTax

number

The Non-resident Tax value.

PrintConfirmation

boolean

Indicates if a Confirmation is printed or not.

PrintCertificate

boolean

Indicates if a Certificate is printed or not.

PrintMaturity

boolean

Indicates if a Maturity Notice is printed or not.

IntendedUseCode

string

Unique identifier of the Intended Use Code. Field values are accessed through the System Administration specification endpoint GET /System/Companies/{Company}/IntendedUses.

PADInformation

object

JointClientNumber

int64

The unique Portfolio+ Client identifier for the Joint Owner. NOTE - This field is only used for the POST endpoint to assign a single joint owner and is not recoverable. Maintenance of joint owners is done via the Term Deposit Related Clients endpoints. Field values are accessed through the Client Management specification endpoint GET /Clients/Profile.

JointOwnershipPercentage

number

The ownership percentage of the Joint Owner. Specified values impact the Primary Owner Ownership Percentage. NOTE - This field is only used for the POST endpoint to assign a single joint owner and is not recoverable. Maintenance of joint owners is done via the Term Deposit Related Clients endpoints.

FromRetailAccount

boolean

required

Indicates if the Term Deposit is to be purchased from an internal retail account. This field is only used for the POST endpoint and will not be recoverable.

RetailAccountCompany

string

The unique Company identifier associated to the Retail Account. NOTE - This field is only used for the POST endpoint and is not be recoverable. Field values are accessed through the System Administration specification endpoint GET /System/Companies.

RetailAccountNumber

int64

The unique Retail Account identifier. NOTE - This field is only used for the POST endpoint and is not be recoverable. Field values are accessed through the Retail specification endpoint GET /{Company}/Retail/Accounts.

AgentCommissionRate

number

The Agent Commission Rate. The Agent Commission Amount is calculated if the Agent Commission Rate is specified.

AgentCommissionAmount

number

The Agent Commission Amount. This is required only if the Agent Commission Rate is not specified.

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.

Branch

string

AgentNumber

int64

The Agent Number affiliated with the Term Deposit. Field values are accessed through the Agent Management specification endpoint GET /Agents/Profiles.

ClientNumber

int64

The unique Portfolio+ Client identifier. Field values are accessed through the Client Management specification endpoint GET /Clients/Profile.

AccountNumber

int64

The unique account identifier.

AccountType

string

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

Status

string

The Term Deposit Account Status. Field values are accessed through the Term Deposits specification endpoint GET /System/TermDeposits/StatusTypes.

BankCode

string

The Company Bank Code for the term Deposit. Field values are accessed through the System Administration specification endpoint GET /System/Companies/{Company}/BankAccounts.

OwnerType

string

The Term Deposit Ownership Type. Field values are accessed through the Term Deposits specification endpoint GET /System/TermDeposits/OwnershipTypes.

PlanCompany

string

The Company Code of the Investment Plan for the CIF. Field values are accessed through the System Administration specification endpoint GET /System/Companies.

PlanNumber

int64

The Investment Plan Number for the CIF. Field values are accessed through the Investment specification endpoint GET /Investments/{Company}.

PurchaseMethod

string

Field values are accessed through the Term Deposits specification endpoint GET /System/TermDeposits/PurchaseMethods.

IssueDate

date

The Date the Term deposit was issued.

TermMonths

int32

The Term Deposit duration in months. This value is calculated if MaturityDate is specified.

TermDays

int32

The Term Deposit duration in number of days. This value is calculated if MaturityDate is specified.

MaturityDate

date

The Term Deposit Maturity Date. This value is calculated if TermMonths or TermDays are specified.

IsCompounded

boolean

Indicates if the Term Deposit compounds interest or not.

CompoundFrequency

string

The Term Deposit Compound Frequency. Field values are accessed through the Term Deposits specification endpoint GET /System/TermDeposits/CompoundFrequencies.

Principal

number

The Term Deposit Principal Amount.

PrincipalExceptionCode

string

InterestPayment

number

The Interest Payment due at Term Deposit maturity.

PaymentFrequency

string

The Term Deposit Payment Frequency. Field values are accessed through the Term Deposits specification endpoint GET /System/TermDeposits/PaymentFrequencies.

FirstPaymentDate

date

The First Interest Date of the Term Deposit.

OnFileDate

date

The On File Date of the Term Deposit.

Rate

number

The Term Deposit Interest Rate. Field values are accessed through the Term Deposits specification endpoint GET /System/InterestRates/TermDeposits/{Company}.

RateExceptionCode

string

The Rate Exception Code if the rate changes from the Default Rate. Field values are accessed through the Term Deposits specification endpoint GET /System/TermDeposits/RateExceptions.

PayMode

string

The Payment Mode of the Term Deposit. Field values are accessed through the Term Deposits specification endpoint GET /System/TermDeposits/PayModes.

CombineCheque

boolean

Indicates if Principal and Interest payments combined into one cheque or not.

NonResidentTax

number

The Non-resident Tax value.

PrintConfirmation

boolean

Indicates if a Confirmation is printed or not.

PrintCertificate

boolean

Indicates if a Certificate is printed or not.

PrintMaturity

boolean

Indicates if a Maturity Notice is printed or not.

IntendedUseCode

string

Unique identifier of the Intended Use Code. Field values are accessed through the System Administration specification endpoint GET /System/Companies/{Company}/IntendedUses.

PADInformation

object

JointClientNumber

int64

JointOwnershipPercentage

number

FromRetailAccount

boolean

Indicates if the Term Deposit is to be purchased from an internal retail account. This field is only used for the POST endpoint and will not be recoverable.

RetailAccountCompany

string

RetailAccountNumber

int64

AgentCommissionRate

number

The Agent Commission Rate. The Agent Commission Amount is calculated if the Agent Commission Rate is specified.

AgentCommissionAmount

number

The Agent Commission Amount. This is required only if the Agent Commission Rate is not specified.

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

xxxxxxxxxx
curl --request POST \
     --url https://example.com/termdeposit/web/TermDeposits \
     --header 'accept: application/json' \
     --header 'content-type: application/json' \
     --data '
{
  "PADInformation": {
    "PADSource": "d"
  },
  "FromRetailAccount": true
}
'

xxxxxxxxxx
}
{
  "data": {
    "Company": "PPF",
    "Branch": "0001",
    "AgentNumber": 120,
    "ClientNumber": 178,
    "AccountNumber": 1234567,
    "AccountType": "S",
    "Status": "A",
    "BankCode": "BNK1",
    "OwnerType": "I",
    "PlanCompany": "PPF",
    "PlanNumber": 150,
    "PurchaseMethod": "P",
    "IssueDate": "2022-09-01",
    "TermMonths": 24,
    "TermDays": 180,
    "MaturityDate": "2025-12-01",
    "IsCompounded": true,
    "CompoundFrequency": "M",
    "Principal": 10000,
    "PrincipalExceptionCode": "01",
    "InterestPayment": 500,
    "PaymentFrequency": "A",
    "FirstPaymentDate": "2023-09-01",

201Term Deposit was created

400Unable to understand the request, due to invalid syntax