API Reference

UPI Autopay Create Mandate API

Overview

Registers a new mandate by sending customer VPA, frequency, amount, and validity to Nttdata Payment Services. Routed via Sponsor Bank → NPCI → Issuing Bank/PSP. Customer authorizes on PSP App. Returns UMN on success. Special rules: ₹1 first debit for amountLimit = M; auto-triggered first execution if amountLimit = F and firstDebit = Y.

Description

Initiates mandate registration. Sends customer VPA, frequency, amount, validity to Nttdata Payment Services. Nttdata Payment Services routes via Sponsor Bank → NPCI → Issuing Bank/PSP. Customer authorizes on PSP App. Returns UMN on success. For amountLimit = 'M', a ₹1 first debit occurs immediately. For amountLimit = 'F' with firstDebit = 'Y', first execution is auto-triggered.

Prerequisites

  • Merchant integration with Nttdata Payment Services
  • Customer VPA
  • Mandate parameters (amount, frequency, validity)
  • Sponsor Bank/NPCI routing
  • PSP App authorization

Create Mandate Attributes

This API requires Basic Authentication for access. The request must include valid credentials in the form of a username and password, which will be provided separately. Only authorized users with the correct credentials will be able to successfully authenticate and interact with the API.

Request Attributes

Attribute
Description
data
object (4 fields)
Optional
Root request payload

Response Attributes

Attribute
Description
data
object (4 fields)
Optional
Response payload containing transaction details
code
numberOptional
Status Codes
message
stringOptional
Status Message
description
stringOptional
Status Description