Set Up Recurring Deposit Auto-Debit

Sets up a standing instruction that debits the main account and pays the recurring deposit on a schedule. One auto-debit per deposit.

Field Name	Type	Required	Description
`nuban`	string	TRUE	NUBAN of the customer's main account. It funds the deposit and receives payouts.
`amount`	number	TRUE	Amount debited each time.
`startDate`	string	FALSE	Format yyyy-MM-dd. Defaults to today. The debit falls on this day of the month.
`endDate`	string	FALSE	Format yyyy-MM-dd. Runs until cancelled when absent.
`everyMonths`	integer	FALSE	Debit every N months. Defaults to 1.

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

Path Params

Body Params application/json

Example

{
  "nuban": "0000000206",
  "amount": 20000,
  "startDate": "2026-12-01"
}

Request Code Samples

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

Responses

🟢200Set up

application/json

Set up

Bodyapplication/json

Example

{
  "officeId": 1,
  "clientId": 42,
  "resourceId": 15
}

🟠400Validation failed

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

🟠403Not allowed

🟠404Not found

🟠409Conflict

🔴500The request could not be completed

Request