Open Fixed Deposit

Opens a fixed deposit for an existing customer, funded from their main account, and activates it. The customer is the owner of nuban. The response is the new deposit with its accountNo, which identifies it in every other request.

Request Body

Field Name	Type	Required	Description
`nuban`	string	TRUE	NUBAN of the customer's main account. It funds the deposit and receives payouts.
`productId`	integer	TRUE	Fixed deposit product.
`depositAmount`	number	TRUE	Amount to lock in. 0.01 or greater. Debited from the main account.
`depositPeriod`	integer	TRUE	Length of the deposit, in units of `depositPeriodFrequencyId`.
`depositPeriodFrequencyId`	integer	TRUE	Unit of the period: 0 days, 1 weeks, 2 months, 3 years.
`maturityInstruction`	string	TRUE	What happens at maturity: `WITHDRAW_DEPOSIT`, `TRANSFER_TO_MAIN_ACCOUNT`, `REINVEST_PRINCIPAL_AND_INTEREST` or `REINVEST_PRINCIPAL_ONLY`.
`transferInterestToMainAccount`	boolean	FALSE	Credit interest to the main account as it is posted. Defaults to false.

Request

Authorization

OAuth 2.0

Client Credentials

Add the parameter

Authorization

to Headers，whose value is to concatenate the Token after the Bearer.

Example:

Authorization: Bearer ********************

Token URL: {{tpGatewayHostUrl}}/security/authenticate

Body Params application/json

Example

{
  "nuban": "0000000206",
  "productId": 2,
  "depositAmount": 500000,
  "depositPeriod": 6,
  "depositPeriodFrequencyId": 2,
  "maturityInstruction": "TRANSFER_TO_MAIN_ACCOUNT",
  "transferInterestToMainAccount": false
}

Request Code Samples

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

Responses

🟢200Deposit opened

application/json

Deposit opened

Bodyapplication/json

Example

{
  "accountNo": "000000123",
  "status": {
    "value": "Active"
  },
  "depositAmount": 500000,
  "maturityDate": [
    2027,
    5,
    10
  ],
  "maturityAmount": 530000
}

🟠400Validation failed

🟠401The merchant's account has not been granted this operation,

🟠403Not allowed

🟠404Not found

🔴500The request could not be completed

Request Body#

Request

Request Code Samples

Responses

Request Body