Skip to content

docs(UPIIS-47): document alias, param defaults, otpRequired semantics #448

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
Anindya-Pandey merged 1 commit into from
Jul 19, 2026
Merged

docs(UPIIS-47): document alias, param defaults, otpRequired semantics #448

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
86 changes: 48 additions & 38 deletions api-references/payments/upi-issuance.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -217,6 +217,7 @@
"example": {
"traceId": "01ARZ3NDEKTSV4RRFFQ69G5FAV",
"user": {
"alias": "919999999999",
"deviceId": "device-abc-123",
"id": "01ARZ3NDEKTSV4RRFFQ69G5FAV",
"mobile": "919999999999",
Expand Down Expand Up @@ -376,7 +377,7 @@
"example": {
"deviceId": "device-abc-123",
"mobile": "919999999999",
"vpa": "919999999999-alice@setu"
"vpa": "919999999999-acme@setu"
}
}
}
Expand Down Expand Up @@ -661,7 +662,7 @@
"deviceId": "device-abc-123",
"mobile": "919999999999",
"otp": "123456",
"vpa": "919999999999-alice@setu"
"vpa": "919999999999-acme@setu"
}
}
}
Expand All @@ -677,6 +678,7 @@
"example": {
"traceId": "01ARZ3NDEKTSV4RRFFQ69G5FAV",
"user": {
"alias": "919999999999",
"deviceId": "device-abc-123",
"id": "01ARZ3NDEKTSV4RRFFQ69G5FAV",
"mobile": "919999999999",
Expand All @@ -692,7 +694,7 @@
"mobile": "919999999999",
"programId": "01ARZ3NDEKTSV4RRFFQ69G5FAV",
"status": "active",
"vpa": "919999999999-alice@setu"
"vpa": "919999999999-acme@setu"
}
}
}
Expand Down Expand Up @@ -965,7 +967,7 @@
"deviceId": "device-abc-123",
"mobile": "919999999999",
"programId": "01ARZ3NDEKTSV4RRFFQ69G5FAV",
"vpa": "919999999999-alice@setu"
"vpa": "919999999999-acme@setu"
}
}
}
Expand All @@ -981,7 +983,7 @@
"example": {
"available": true,
"traceId": "01ARZ3NDEKTSV4RRFFQ69G5FAV",
"vpa": "919999999999-alice@setu"
"vpa": "919999999999-acme@setu"
}
}
}
Expand Down Expand Up @@ -1224,7 +1226,7 @@
"mobile": "919999999999",
"otpRequired": false,
"programId": "01ARZ3NDEKTSV4RRFFQ69G5FAV",
"vpa": "919999999999-alice@setu"
"vpa": "919999999999-acme@setu"
}
}
}
Expand All @@ -1249,7 +1251,7 @@
"mobile": "919999999999",
"programId": "01ARZ3NDEKTSV4RRFFQ69G5FAV",
"status": "active",
"vpa": "919999999999-alice@setu"
"vpa": "919999999999-acme@setu"
}
}
}
Expand Down Expand Up @@ -1487,7 +1489,7 @@
"example": {
"deviceId": "device-abc-123",
"mobile": "919999999999",
"vpa": "919999999999-alice@setu"
"vpa": "919999999999-acme@setu"
}
}
}
Expand All @@ -1512,7 +1514,7 @@
"mobile": "919999999999",
"programId": "01ARZ3NDEKTSV4RRFFQ69G5FAV",
"status": "active",
"vpa": "919999999999-alice@setu"
"vpa": "919999999999-acme@setu"
}
}
}
Expand Down Expand Up @@ -1776,7 +1778,7 @@
"mobile": "919999999999",
"programId": "01ARZ3NDEKTSV4RRFFQ69G5FAV",
"status": "active",
"vpa": "919999999999-alice@setu"
"vpa": "919999999999-acme@setu"
},
{
"accountName": "Alice Doe",
Expand All @@ -1788,7 +1790,7 @@
"mobile": "919999999999",
"programId": "01ARZ3NDEKTSV4RRFFQ69G5FAV",
"status": "active",
"vpa": "919999999999-alice@setu"
"vpa": "919999999999-acme@setu"
}
]
}
Expand Down Expand Up @@ -2021,7 +2023,7 @@
"example": {
"deviceId": "device-abc-123",
"mobile": "919999999999",
"vpa": "919999999999-alice@setu"
"vpa": "919999999999-acme@setu"
}
}
}
Expand All @@ -2046,7 +2048,7 @@
"mobile": "919999999999",
"programId": "01ARZ3NDEKTSV4RRFFQ69G5FAV",
"status": "active",
"vpa": "919999999999-alice@setu"
"vpa": "919999999999-acme@setu"
}
}
}
Expand Down Expand Up @@ -3393,6 +3395,7 @@
"example": {
"traceId": "01ARZ3NDEKTSV4RRFFQ69G5FAV",
"user": {
"alias": "919999999999",
"deviceId": "device-abc-123",
"id": "01ARZ3NDEKTSV4RRFFQ69G5FAV",
"mobile": "919999999999",
Expand Down Expand Up @@ -3615,15 +3618,15 @@
"pattern": "^([A-Za-z0-9.-]+)@([A-Za-z0-9.-]+)$",
"minLength": 1,
"maxLength": 255,
"description": "The full VPA to check (prefix@handle, e.g. 919999999999-alice@setu). Its prefix must start with the user's mobile number.",
"example": "919999999999-alice@setu"
"description": "The full VPA to check (prefix@handle, e.g. 919999999999-acme@setu). Its prefix must start with the user's mobile number.",
"example": "919999999999-acme@setu"
}
},
"example": {
"deviceId": "device-abc-123",
"mobile": "919999999999",
"programId": "01ARZ3NDEKTSV4RRFFQ69G5FAV",
"vpa": "919999999999-alice@setu"
"vpa": "919999999999-acme@setu"
},
"required": [
"deviceId",
Expand Down Expand Up @@ -3748,8 +3751,8 @@
"pattern": "^([A-Za-z0-9.-]+)@([A-Za-z0-9.-]+)$",
"minLength": 1,
"maxLength": 255,
"description": "The full VPA to create (prefix@handle, e.g. 919999999999-alice@setu). Its prefix must start with the user's mobile number.",
"example": "919999999999-alice@setu"
"description": "The full VPA to create (prefix@handle, e.g. 919999999999-acme@setu). Its prefix must start with the user's mobile number.",
"example": "919999999999-acme@setu"
}
},
"example": {
Expand All @@ -3763,7 +3766,7 @@
"mobile": "919999999999",
"otpRequired": false,
"programId": "01ARZ3NDEKTSV4RRFFQ69G5FAV",
"vpa": "919999999999-alice@setu"
"vpa": "919999999999-acme@setu"
},
"required": [
"deviceId",
Expand Down Expand Up @@ -3797,7 +3800,7 @@
"mobile": "919999999999",
"programId": "01ARZ3NDEKTSV4RRFFQ69G5FAV",
"status": "active",
"vpa": "919999999999-alice@setu"
"vpa": "919999999999-acme@setu"
}
},
"required": [
Expand Down Expand Up @@ -3826,14 +3829,14 @@
"pattern": "^([A-Za-z0-9.-]+)@([A-Za-z0-9.-]+)$",
"minLength": 1,
"maxLength": 255,
"description": "The full VPA to fetch (prefix@handle, e.g. 919999999999-alice@setu). Its prefix must start with the user's mobile number.",
"example": "919999999999-alice@setu"
"description": "The full VPA to fetch (prefix@handle, e.g. 919999999999-acme@setu). Its prefix must start with the user's mobile number.",
"example": "919999999999-acme@setu"
}
},
"example": {
"deviceId": "device-abc-123",
"mobile": "919999999999",
"vpa": "919999999999-alice@setu"
"vpa": "919999999999-acme@setu"
},
"required": [
"deviceId",
Expand Down Expand Up @@ -3914,6 +3917,7 @@
"example": {
"traceId": "01ARZ3NDEKTSV4RRFFQ69G5FAV",
"user": {
"alias": "919999999999",
"deviceId": "device-abc-123",
"id": "01ARZ3NDEKTSV4RRFFQ69G5FAV",
"mobile": "919999999999",
Expand All @@ -3929,7 +3933,7 @@
"mobile": "919999999999",
"programId": "01ARZ3NDEKTSV4RRFFQ69G5FAV",
"status": "active",
"vpa": "919999999999-alice@setu"
"vpa": "919999999999-acme@setu"
}
},
"required": [
Expand Down Expand Up @@ -4141,13 +4145,13 @@
"minLength": 1,
"maxLength": 255,
"description": "Include the VPA to verify a new VPA (new onboarding / new VPA); omit for a device-change OTP (SIM re-binding).",
"example": "919999999999-alice@setu"
"example": "919999999999-acme@setu"
}
},
"example": {
"deviceId": "device-abc-123",
"mobile": "919999999999",
"vpa": "919999999999-alice@setu"
"vpa": "919999999999-acme@setu"
},
"required": [
"deviceId",
Expand Down Expand Up @@ -4212,6 +4216,11 @@
"UserView": {
"type": "object",
"properties": {
"alias": {
"type": "string",
"description": "The user's alias: the prefix of their VPAs. Defaults to the mobile.",
"example": "919999999999"
},
"deviceId": {
"type": "string",
"description": "The user's device id.",
Expand All @@ -4234,6 +4243,7 @@
}
},
"example": {
"alias": "919999999999",
"deviceId": "device-abc-123",
"id": "01ARZ3NDEKTSV4RRFFQ69G5FAV",
"mobile": "919999999999",
Expand Down Expand Up @@ -4272,14 +4282,14 @@
"minLength": 1,
"maxLength": 255,
"description": "Include the VPA to verify a new VPA (new onboarding / new VPA); omit for a device-change OTP (SIM re-binding).",
"example": "919999999999-alice@setu"
"example": "919999999999-acme@setu"
}
},
"example": {
"deviceId": "device-abc-123",
"mobile": "919999999999",
"otp": "123456",
"vpa": "919999999999-alice@setu"
"vpa": "919999999999-acme@setu"
},
"required": [
"deviceId",
Expand All @@ -4303,13 +4313,13 @@
"vpa": {
"type": "string",
"description": "The full VPA that was checked (prefix@handle).",
"example": "919999999999-alice@setu"
"example": "919999999999-acme@setu"
}
},
"example": {
"available": true,
"traceId": "01ARZ3NDEKTSV4RRFFQ69G5FAV",
"vpa": "919999999999-alice@setu"
"vpa": "919999999999-acme@setu"
},
"required": [
"traceId",
Expand Down Expand Up @@ -4347,7 +4357,7 @@
"mobile": "919999999999",
"programId": "01ARZ3NDEKTSV4RRFFQ69G5FAV",
"status": "active",
"vpa": "919999999999-alice@setu"
"vpa": "919999999999-acme@setu"
},
{
"accountName": "Alice Doe",
Expand All @@ -4359,7 +4369,7 @@
"mobile": "919999999999",
"programId": "01ARZ3NDEKTSV4RRFFQ69G5FAV",
"status": "active",
"vpa": "919999999999-alice@setu"
"vpa": "919999999999-acme@setu"
},
{
"accountName": "Alice Doe",
Expand All @@ -4371,7 +4381,7 @@
"mobile": "919999999999",
"programId": "01ARZ3NDEKTSV4RRFFQ69G5FAV",
"status": "active",
"vpa": "919999999999-alice@setu"
"vpa": "919999999999-acme@setu"
}
]
}
Expand All @@ -4390,7 +4400,7 @@
"mobile": "919999999999",
"programId": "01ARZ3NDEKTSV4RRFFQ69G5FAV",
"status": "active",
"vpa": "919999999999-alice@setu"
"vpa": "919999999999-acme@setu"
},
{
"accountName": "Alice Doe",
Expand All @@ -4402,7 +4412,7 @@
"mobile": "919999999999",
"programId": "01ARZ3NDEKTSV4RRFFQ69G5FAV",
"status": "active",
"vpa": "919999999999-alice@setu"
"vpa": "919999999999-acme@setu"
},
{
"accountName": "Alice Doe",
Expand All @@ -4414,7 +4424,7 @@
"mobile": "919999999999",
"programId": "01ARZ3NDEKTSV4RRFFQ69G5FAV",
"status": "active",
"vpa": "919999999999-alice@setu"
"vpa": "919999999999-acme@setu"
}
]
},
Expand Down Expand Up @@ -4474,7 +4484,7 @@
"vpa": {
"type": "string",
"description": "The full VPA, prefix@handle.",
"example": "919999999999-alice@setu"
"example": "919999999999-acme@setu"
}
},
"example": {
Expand All @@ -4487,7 +4497,7 @@
"mobile": "919999999999",
"programId": "01ARZ3NDEKTSV4RRFFQ69G5FAV",
"status": "active",
"vpa": "919999999999-alice@setu"
"vpa": "919999999999-acme@setu"
},
"required": [
"id",
Expand Down
Loading
Loading