Open Recurring Deposit

Opens a recurring deposit linked to the customer's main account and activates it. The response carries the new deposit's accountNo.

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	Recurring deposit product.
`installmentAmount`	number	TRUE	Amount of each instalment. 0.01 or greater.
`frequency`	integer	TRUE	Time between instalments, in units of `frequencyType`.
`frequencyType`	integer	TRUE	0 days, 1 weeks, 2 months.
`term`	integer	TRUE	Length of the deposit, in units of `termType`.
`termType`	integer	TRUE	0 days, 1 weeks, 2 months, 3 years.
`firstInstalmentDate`	string	FALSE	Format yyyy-MM-dd. Defaults to today.

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": 3,
  "installmentAmount": 20000,
  "frequency": 1,
  "frequencyType": 2,
  "term": 12,
  "termType": 2
}

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": "000000456",
  "status": {
    "value": "Active"
  },
  "mandatoryRecommendedDepositAmount": 20000
}

🟠400Validation failed

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

🟠403Not allowed

🟠404Not found

🔴500The request could not be completed

Request