UPI Mandate Registration API

post

https://stagingplatformapi.kudosfinance.in/api/mandatecreate

This is used to make transaction requests from merchants to CAMS Pay for checking the Payer VPA is valid or not for the UPI Mandate creation.

Body Params

partner_loan_id

string

required

Defaults to MNHYT5432R

characters accepted, max length 200. This contains the partner loan ID for the request that is being sent

partner_borrower_id

string

required

Defaults to ABVG65467

Alphanumeric characters accepted, max length 200. Borrower ID at partner's end

kudos_loan_id

string

required

Defaults to 7687654321234

13 digits Numbers only. This contains the kudos loan ID for the request that is being sent, as was generated in the "Loan Request" API.

kudos_borrower_id

string

required

Defaults to MNHYTREDF

Alphanumeric characters accepted, max length 200, Alphanumeric characters accepted, max length 200.

amount

float

required

Defaults to 5000.12

It should accept Numbers only, This contain total EMI amount or the amount paid by the customer.

pattern

string

required

Defaults to ASPRESENTED

Frequency pattern for the mandate :- i)ONETIME ii)MONTHLY iii)WEEKLY iv)DAILY v)QUARTERLY vi)BI-MONTHLY vii)FORTNIGHTLY viii)HALFYEARLY ix)YEARLY x) ASPRESENTED

ruletype

string

Defaults to ON

Three available types "ON", “BEFORE” and "AFTER". If Pattern is ONETIME / ASPRESENTED / DAILY / MONTHLY, then rule type must be empty or is not required.

rulevalue

string

Defaults to Date

Two available types "Date" and "Day". on which the mandated amount will be debited. If Pattern is ONETIME / ASPRESENTED / DAILY / MONTHLY, then rule value must be empty or is not required.

mandatestartdate

date

required

Defaults to 2021-11-08

Date of the first installment. This should be current date.

mandateenddate

date

required

Defaults to 2022-11-08

Date of the last installment. This should be greater than the EMI start date

payervpa

string

required

Defaults to 1234567891@ybl

Alphanumeric accepted, max length 200 and @ is required. UPI id of the customer

payername

string

required

Defaults to John

Alphanumeric characters accepted, max length 20. Name to the customer.

executabledays

string

Defaults to 5

It should accept numbers. On which date of every month the mandate will execute. This is required only if the pattern is MONTHLY. Executable days based on the pattern selected. Eg: if Monthly, value: 1 to 31. If the executable day is 5 then the value is "executabledays": "5"

Responses

200200

400400