Prepaid Card Middleware

Document

Document Control
Created Revision Review Author Process Approval
Version
Date Function Frequency Name Owner Date
Bikas
26-03-20 New Service Sonali
v1.0 3 Months Kumar
24 Product Creation Parida
Behera
Bikas
26-04-20 New Service for Sonali
v2.0 1Months kumar
24 selfsignup APIs Parida
Behera

Stakeholder Sign Off

Raised Stakeholder Stakeholder's
Version Signoff Date
Date Name Function/Department
28-03-2024 1 Reeturaj Sahoo Tech
28-04-2024 2 Reeturaj Sahoo Tech

Card Management System (CMS) Issuer Interface guide

Integration Document confidential
iServeU pvt ltd © 2023 Page 1 of 121
Table of Contents
1. INTRODUCTION.....................................................................................................................3
1.1 Objectives..............................................................................................................................3
1.2 Overview of System Functionality....................................................................................... 4
2. POTENTIAL SOLUTION....................................................................................................... 4
3. ASSUMPTIONS........................................................................................................................5
4. CONSTRAINTS........................................................................................................................5
5. SYSTEM DESIGN AND ARCHITECTURE........................................................................ 6
5.1 System Diagram....................................................................................................................6
5.2 Terminology and Components.............................................................................................. 7
5.3 Hard and Soft Dependencies.................................................................................................8
5.4 ALGORITHM.......................................................................................................................8
5.5 SERVICE GUARANTEES...................................................................................................8
5.6 DATA DEFINITION, SCHEMA DESIGN, AND PERSISTENCE REQUIREMENTS.....8
5.7 CACHING REQUIREMENTS.............................................................................................8
5.8 CAPACITY PLANNING......................................................................................................8
5.9 PERFORMANCE REQUIREMENTS................................................................................. 8
5.10 SECURITY......................................................................................................................... 8
5.11 MULTI-REGION STORY.................................................................................................. 9
6. API/gRPC END POINTS......................................................................................................... 9
6.1 Program Manager..................................................................................................................9
6.1.1 Add Product API.........................................................................................................9
6.1.2 Fetch Product API.....................................................................................................15
6.2 Checker............................................................................................................................... 20
6.2.1 Approve Product API................................................................................................20
6.3 Card.....................................................................................................................................21
6.3.1 Generate Otp API
…………………………………………………………………………………………………2
2
6.3.2 View Card details
API……………………………………………………………………………………………
23
6.3.3 view Card Cvv API
………………………………………………………………………………………………..24
6.3.4 view Card Balance API
…………………………………………………………………………………………25
6.3.5 SelfSignOn
API………………………………………………………………………………………………
…… 26
6.3.6 verify Self signON
API……………………………………………………………………………………………27
6.3.7 Resend Otp

Card Management System (CMS) Issuer Interface guide

Integration Document confidential
iServeU pvt ltd © 2023 Page 2 of 121
 API………………………………………………………………………………………………
…….28
7. ROLLOUT PLAN...................................................................................................................32
8. TEST PLAN............................................................................................................................ 32
9. APPENDIX.............................................................................................................................. 32

1. Introduction
The project focuses on developing a middleware system that seamlessly integrates user
creation, inventory management, cms module and transaction middleware (not yet
implemented). It aims to streamline processes, optimize inventory management, and ensure
precise transaction execution while interacting securely with Bank APIs.

1.1 Objective
The overarching objective of the middleware system is to create a cohesive platform that
seamlessly integrates two critical units: User Creation and Inventory Management, and
Transaction Middleware. The specific goals include:

1. Efficient User Onboarding

● Streamline the creation of Bank Admin, Program Managers (PM) and Corporate
Managers (CM) through the user-management API, ensuring a seamless onboarding
process with maker checker and role privilege implementation.
● Enable individual customer creation, adapting to card types (GPR/GIFT) with
interactions with the user-management, FINO OTP generation, and FINO
Registration APIs.

2. Optimized Inventory Management

● Store product details assigned to Program Managers, Bank Admin efficiently in the
middleware database.
● Facilitate corporate card orders by calling the APIs, assigning unique GEN LOT
REFERENCE NUMBERs, and seamlessly linking cards to customers, storing
relevant details in the middleware database.

3. CMS Module Integration:

● It acts as a centralized platform for managing content seamlessly integrated within the
middleware architecture.

Card Management System (CMS) Issuer Interface guide

Integration Document confidential
iServeU pvt ltd © 2023 Page 3 of 121
 ● Facilitates further configuration and management of user accounts post-onboarding.
● Ensures seamless integration with the middleware's user-management API for
efficient user handling.

4. Precise Transaction Middleware

● Implement transactional operations such as Transaction Posting, Partial Reversal, Full
Reversal, and Cash Load with precision.
● Call the respective Fino Bank APIs for each transaction operation, ensuring secure
and accurate execution.
● Store transaction details against the relevant card reference number in the middleware
database upon receiving success responses.

1.2 Overview of System Functionality

The system's functionality encompasses distinct modules:

1. User Creation
● Gather essential data required for user creation.
● Initiates the onboarding process to user management upon data provision.
● Routes the user to the CMS endpoint post successful onboarding.
● Concludes the customer onboarding process upon successful CMS onboarding.
● Dispatches userID and password to the user for access.
● Efficient inventory management, storing product details, handling corporate card
orders, and managing unique reference numbers.

2. Inventory Management
● Facilitates linking, shipping, and ordering of cards.
● Efficiently manages inventory, encompassing product details and unique reference
numbers.
● Ensures streamlined inventory management, covering storage of product details,
handling corporate card orders, and managing unique reference numbers.

3. Transaction Middleware:
● Not yet Implemented

In summary, the middleware serves as the linchpin for creating and managing users and
inventory, while also orchestrating secure and efficient financial transactions. By seamlessly
integrating various APIs and components, the project aims to elevate the efficiency, security,
and overall functionality of our enterprise systems.

2. Potential Solution
1. Custom Middleware Development

Card Management System (CMS) Issuer Interface guide

Integration Document confidential
iServeU pvt ltd © 2023 Page 4 of 121
 ● Design and build bespoke middleware components tailored to project needs, fostering
modularity and ease of integration.
● Implement a modular architecture to enhance flexibility and scalability, ensuring
seamless integration and efficient operation.

2. Cloud-Based Solutions Utilization

● Deploying middleware components on Kubernetes within cloud platforms like
Google Cloud for scalable, reliable, and cost-effective management of system
functionalities.

3. Assumptions
1. Stability of Bank APIs
● Assuming that the APIs provided by the Bank are stable and reliable for processing
transactions.

2. Accuracy of User Data

● Assuming that the user data provided is accurate and complete as outlined in the Api
Endpoints section (15), ensuring smooth operations.

3. Availability of Necessary Resources

● Assuming that the middleware system will have access to the necessary resources and
infrastructure required for seamless integration and operation, ensuring uninterrupted
functionality.

4. Constraints
● Not Applicable

Card Management System (CMS) Issuer Interface guide

Integration Document confidential
iServeU pvt ltd © 2023 Page 5 of 121
5. System Design and Architecture
5.1 System diagram

High Level Design

Card Management System (CMS) Issuer Interface guide

Integration Document confidential
iServeU pvt ltd © 2023 Page 6 of 121
 Low Level Design

5.2 Terminology and components

1. Middleware
● The core software component that acts as a bridge between different applications,
facilitating communication and data exchange.

2. User-Management API
● An Application Programming Interface responsible for managing the creation,
approval, and onboarding of users, including Program Managers (PM) and Corporate
Managers (CM).

3. CMS API (Card Management System)

● An API dedicated to registering and managing users within the Content Management
System, ensuring seamless integration with the middleware.

4. FINO OTP Generation API

● An Application Programming Interface specifically designed to generate One-Time
Passwords (OTPs) for user authentication during customer creation.

5. FINO Registration API

● An API utilized for registering users with FINO, ensuring successful onboarding of
customers based on assigned card types (GPR/GIFT).

6. GEN-LOT-REFERENCE NUMBER
● A unique identifier assigned to corporate card orders, managing, and tracking each
corporate order throughout the inventory management process.

7. Fino Bank APIs

● A set of Application Programming Interfaces for various financial transactions,
including Transaction Posting, Partial Reversal, Full Reversal, and Cash Load
operations.

8. JIT API (Just-In-Transaction API)

● Encompasses JIT LOAD, JIT PARTIAL REVERSAL, and JIT FULL REVERSAL
APIs, which are designed for instant loading, partial reversal, and full reversal of
transactions.

9. Inventory Database
● The storage repository within the middleware system where details such as user
information, product assignments, and transaction records are securely stored.

10. Response Body Type

● The format in which the API responses are structured, ensuring consistency and ease
of integration with other components.

Card Management System (CMS) Issuer Interface guide

Integration Document confidential
iServeU pvt ltd © 2023 Page 7 of 121
5.3 Hard and soft dependencies
Hard Dependencies
● Not Applicable

Soft Dependencies
● Databases like MongoDB and PostgreSQL
● Orchestration platforms like Kubernetes
● Monitoring and Logging Tools
● Middleware components like User Management Application and Card
Management Application

5.4 Algorithm
● Not Applicable

5.5 Expected Service Guarantees

● Not Applicable

5.6 Data definition, schema design and Persistence requirements

● Not Applicable

5.7 Caching requirements

● Not Applicable

5.8 Capacity planning

● Not Applicable

5.9 Performance requirements

● Not Applicable

5.10 Security
● Not Applicable

5.11 Multi region story

Card Management System (CMS) Issuer Interface guide

Integration Document confidential
iServeU pvt ltd © 2023 Page 8 of 121
 1. Location of Databases
● MongoDB
● Primary Location:
● Secondary/Backup Location:
● PostgreSQL
● Primary Location:
● Secondary/Backup Location:
● Other Infrastructure Locations
● Orchestration Platforms (Kubernetes):
● Middleware Components
1. User Management:
2. Card Management:

6. APIs Endpoints
Notes:-
1.WL url:-https://capidev.iserveu.online/
put authorization token in header i.e
Authorization:eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9.eyJyZWRpcmVjdFVya
SI6bnVsbCwiYmFua0NvZGUiOiJkZW1vIiwicGFzc3dvcmRSZXNldFJlcXVpcmVkUmVhc
29uIjpudWxsLCJ1c2VyX25hbWUiOiJEZW1vSXN1QmFua01ha2VyT3BzIiwibW9iaWxlTn
VtYmVyIjo4NTQ4ODc3MTAzLCJjcmVhdGVkIjoxNzE0NDU3MjA2MDkwLCJhdXRob3J
pdGllcyI6WyJST0xFX0FETUlOX01BS0VSX09QU19TVUIiXSwiY2xpZW50X2lkIjoiY29t
bW9uLWFkbWlucy1vYXV0aDItY2xpZW50IiwiYWRtaW5OYW1lIjoiaWNpY2liYW5rYW
RtIiwiaXNQYXNzd29yZFJlc2V0UmVxdWlyZWQiOmZhbHNlLCJzY29wZSI6WyJyZWFk
Iiwid3JpdGUiXSwidXNlclR5cGUiOiJUUkFOU0FDVElPTkFMIiwiZXhwIjoxNzE0NDU5
MDA2LCJqdGkiOiI0YjYzMjBlNi0yZDkwLTRmMGItODk5Ni0xNGMwN2E0ZjkxNDUif
Q.PAB2LHIb2-JzNphKhvURhJt-e91u4qJBKL_wr9civQGfiugcDdT7j6QjtuR6uFBFA2n96C
nzeFslMPmI__J2eFgLfLY4Huf_F7YPlxidOpDyhEJiibq70onYqnsiu2WDwX5t0YMngkzxMj
ooy1YjH135TFKde9dktR7Ue77xCigH8eIPRahVFVuYhKuXD-i3sGhML7sOLEhcQp6vGEt
tESOXHllawOqOn7-DkClrAYasmT7FIOjFbg7R4gRwVna_KXivEbWHVM_1LPNfo58viKx
QybwPumzR9BWny7-Y4VN2lW7d24KnZw90kuwPWl3LtOTPqmVveC05nZ-ATmIQ4g

2.api user url:-https://capidev.iserveu.online/apiuser

Put client id and client secret in header
"client_id":
"8c0430b65dc250498af1ee56a87264adfd3033674fed40ad3e073860eb56e2c0efb261df95031a121b837e6f9073ebbb"
,
"client_secret":
"1dbdc51d4901478572403eaeb118a8005c36188af6c3ac608d1195bc1db92f12d4e7f632f6852a628660601c7748803d
d522ecde40322ed4a5817866d77226b4",
"apiuserName": "CORP8763112029"

Card Management System (CMS) Issuer Interface guide

Integration Document confidential
iServeU pvt ltd © 2023 Page 9 of 121
6.1 Master Creation
6.1.1 Create Department API:
This API will be used to create a department.

End Point: /user/create_department

Request/Response Fields

Request Payload

Request Payload

department It is used to create a string 1 50 Y Must

department. be a
unique
string

channel channel must be string 1 10 Y Manda

ANDROID or WEB tory
for all

Response Payload
status Status of the performed string Y
action. E.g. – SUCCESS
or FAILED

statusCode This field describes the integer Y

Status Code of a
performed Action. Eg-
success (0), failed
(1),failed(-1) for token
authorization failed

statusDesc Description of the status string N

of the performed action

data Response of the CMS Y

API

Sample API Payload

Request Payload:

"department":"thwdepartment",

Card Management System (CMS) Issuer Interface guide

Integration Document confidential
iServeU pvt ltd © 2023 Page 10 of 121
"channel":"WEB"

Success Response Payload:

{
"statusCode": 0,
"status": "SUCCESS",
"statusDesc": "Successfully created Department",
"data": {
"_id": "66756a2c1e9cf25e7d08c2a4"
}
}

Failed Response Payload:

{
“statusCode”: 1,
“status” : “FAILED”,
“statusDesc”: “This department thwdepartment already exist”,
“data” : specific error
}

6.1.2 Create Designation API:

This API will be used to create a designation against a specific department.

End Point: /user/create_designation

Request/Response Fields

Request Payload

department This is the parameter string 1 50 Y The

which is used to create depart
designation ment
must
be the
existin
g one

designation It is used to create string 1 50 Y Multip

designation against the le
department design
ation
can be

Card Management System (CMS) Issuer Interface guide

Integration Document confidential
iServeU pvt ltd © 2023 Page 11 of 121
 inserte
d
agains
t the
depart
ment

channel channel must be string 1 10 Y Manda

ANDROID or WEB tory
for all

Response Payload
status Status of the performed string Y
action. E.g. – SUCCESS
or FAILED

statusCode This field describes the integer Y

Status Code of a
performed Action. Eg-
success (0), failed
(1),failed(-1) for token
authorization failed

statusDesc Description of the status string N

of the performed action

data Response of the CMS Y

API

Sample API Payload

Request Payload:

"designation": [ "Module Lead"],

"department": "thwdepartment",

"channel": "WEB"

Success Response Payload:

{
"statusCode": 0,
"status": "SUCCESS",
"statusDesc": "Successfully inserted Designation",

Card Management System (CMS) Issuer Interface guide

Integration Document confidential
iServeU pvt ltd © 2023 Page 12 of 121
 "data": {
"_id": "66756a2c1e9cf25e7d08c2a4"
}
}

Failed Response Payload:

{
“statusCode”: 1,
“status” : “FAILED”,
“statusDesc”: “User does not have access to create designation name”,
“data” :{}
}

6.1.3 Create Branch API:

This API will be used to create a branch.

End Point: /user/create_branch

Request/Response Fields

Request Payload

Request Payload

branchName It is used to create a string 1 50 Y

Branch. Branc
h
name
is
specifi
c

zone channel must be string 1 10 Y This

ANDROID or WEB is the
zone
as per
the
directi
ons,
eg.
north
zone,
south
zone

Card Management System (CMS) Issuer Interface guide

Integration Document confidential
iServeU pvt ltd © 2023 Page 13 of 121
 branchAddress This is the address of the string 1 500 Y This
branch inserted is a
string
based
data
within
500
charac
ters

channel It must be either string 1 10 Y Manda

ANDROID or WEB tory
for all

Response Payload
status Status of the performed string Y
action. E.g. – SUCCESS
or FAILED

statusCode This field describes the integer Y

Status Code of a
performed Action. Eg-
success (0), failed
(1),failed(-1) for token
authorization failed

statusDesc Description of the status string N

of the performed action

data Response of the CMS Y

API

Sample API Payload

Request Payload:

"branchName":"gyan_Nagar",

"zone":"middle",

"region":"odisha",

"branchAddress":"Bhimatangi housing board colony, L/B - 36, Old town",

"channel":"WEB"

Card Management System (CMS) Issuer Interface guide

Integration Document confidential
iServeU pvt ltd © 2023 Page 14 of 121
Success Response Payload:

{
"statusCode": 0,
"status": "SUCCESS",
"statusDesc": "Successfully created Branch",
"data": {
"_id": "66756c47a60df8548a28b221"
}
}

Failed Response Payload:

{
“statusCode”: 1,
“status” : “FAILED”,
“statusDesc”: “User doesnot have access to create branch name”,
“data” : {}
}

6.1.4 Create Role API:

This API will be used to create a role.

End Point: /user/create_role

Request/Response Fields

Request Payload

Request Payload

role It is used to create a string 1 50 Y

department.

parentName Must be A , MD , D , R string 1 10 Y Manda

tory
with
specifi
c
value
as A,
MD,
D, R

Card Management System (CMS) Issuer Interface guide

Integration Document confidential
iServeU pvt ltd © 2023 Page 15 of 121
 channel channel must be string 1 10 Y This
ANDROID or WEB is to
be
chosen
with
either
AND
ROID
or
WEB

Response Payload
status Status of the performed string Y
action. E.g. – SUCCESS
or FAILED

statusCode This field describes the integer Y

Status Code of a
performed Action. Eg-
success (0), failed
(1),failed(-1) for token
authorization failed

statusDesc Description of the status string N

of the performed action

data Response of the CMS Y

API

Request Payload:

"role":"frontdeveloper",

"parentName":"R",

"channel":"WEB"

Success Response Payload:

{
"statusCode": 0,
"status": "SUCCESS",
"statusDesc": "Successfully created Role",
"data": {
"_id": "66756cfaa60df8548a28b285",

Card Management System (CMS) Issuer Interface guide

Integration Document confidential
iServeU pvt ltd © 2023 Page 16 of 121
 "roleId": 106,
"roleName": "frontdeveloper"
}
}

Failed Response Payload:

{
“statusCode”: 1,
“status” : “FAILED”,
“statusDesc”: “User doesnot have access to create role name”,
“data” : {}
}

6.2 Bin
6.2.1 Bin Master creation API:
This API will be used to create Bin Number.
End Point: card/bin_master
Request/Response Field

Parameter Name Sub Tag Description Data Type Min Max Mandatory Remarks
Request Payload
binNumber No String 6 8 Y Unique
Bin Number Bin
(6 digits or 8 Number
digits) assigned
by
Network/
Scheme
cardBrand No String 1 10 Y Only
Card Brand given
(RuPay,VISA,Ma value
ster,CUP,JCB,DF allow
S) which is
present in
bracket
cardCoBrand String N
Card Only
Co-brand Mandator
y while
(RuPay,VISA,Ma cardScop
ster,CUP,JCB,DF e is
S,NET, internatio
nal
Mercury)

Card Management System (CMS) Issuer Interface guide

Integration Document confidential
iServeU pvt ltd © 2023 Page 17 of 121
 cardSegment String Y
Card Segment

(Prepaid,Debit
,Credit,

Closed loop)
cardCategory String Y
Card Category

(Platinum,Con
sumer,Corpora
te)
cardVariant String Y
Card Variant

(Classic,Platin
um,Payroll,Gif
t,GPR,

Reimbursemen
t,

Corporate
Gift,T&E,Busi
ness,

Others)
cardBank String Y
Card Bank Bank
Name
should
pass
through
shared
applicatio
n URL
cardServiceCode String Y
Card Service Mandator
Code y

(1xx,2xx,5xx,6x
x) Where x can
be any value

Card Management System (CMS) Issuer Interface guide

Integration Document confidential
iServeU pvt ltd © 2023 Page 18 of 121
 createdBy String Y
createdBy Mandator
y for all
scenarios
cardScope String Y
Card Scope Mandator
y
(International,D
omestic)
channel String Y
Channel can Mandator
ANDROID OR y for all
WEB
Response Payload
status No Status of the String Y
performed
action. E.g. –
SUCCESS or
FAILED
statusCode No This field Integer Y
describes the
Status Code of a
performed
Action. Eg-
success (0),
failed
(1),failed(-1) for
token
authorization
failed
statusDesc No Description of String N
the status of the
performed
action
data No Description of object Y
the CMS

Sample API Payload

Request Payload:

"binNumber": 234567,

"cardBrand": "RuPay",

"cardCoBrand": "VISA",

"cardSegment": "Credit",

Card Management System (CMS) Issuer Interface guide

Integration Document confidential
iServeU pvt ltd © 2023 Page 19 of 121
 "cardCategory": "Consumer",

"cardVariant": "Corporate Gift",

"cardBank":"Cardbank",

"cardServiceCode": "620",

"cardScope":"International",

"createdBy": "fino_admin",

"channel":"WEB"

Response Payload:

"statusCode": 0,

"status": "SUCCESS",

"statusDesc": "Bin Number created successfully",

"data": {}

6.2.2 Bin Range creation API:

This API will be used to create Bin Range
End Point: card/bin_range
Request/Response Field

Parameter Name Su Description Data M M Manda Remar

b Type in ax tory ks
Ta
g

Request Payload

Card Management System (CMS) Issuer Interface guide

Integration Document confidential
iServeU pvt ltd © 2023 Page 20 of 121
 6 8
binNumber N Bin Number Strin YES
O g
(6 digits or 8 digits)
3 3
binRange N Bin range Strin YES
O g
(3 digits)
1
assignedUser N Assigned User Strin YES
O g
Name
1
productCategory N Product Category Strin YES
O g
(GIFT||GPR||CREDIT|SI
NGLE||MULTI||CLOSE
DLOOP)
1
cardType N Card Type Strin YES
O g
(CHIP|CONTACTLESS|
MAGSTRIPE|CUSTOM
ER
CREDIT|COMMERCIA
L CREDIT)
1
createdBy N Bin creator Strin YES
O g
Name

Mandat
poolAccount N poolAccount Strin NO ory if
O g isSelf
(PROGADMIN|ISSUER) assign is
not
availabl
e
1
customerAccount N customerAccount Strin YES
O g
(VIRTUAL|PHYSICAL)
Mandat
programManager No programManagerAccount Strin NO ory
Account g incase
(VIRTUAL|PHYSICAL) of
poolAcc
ount is

Card Management System (CMS) Issuer Interface guide

Integration Document confidential
iServeU pvt ltd © 2023 Page 21 of 121
 ISSUE
R

ncmc N ncmc Bool NO

O ean
If not
isSelfAssign isSelfAssign Bool NO availabl
ean e then
poolAcc
ount
will be
mandat
ory

allowedPmOrderI allowedPmOrderInventor Bool NO

nventory y ean

channel Channel can be strin NO

ANDROID OR WEB g

Response Payload

status N status id Strin YES

O g
contains (“-1”: Failed,
“0”: Success)

statusDesc N status description Strin YES

O g

Sample API Payload

Request Payload:

"binRange": "208",

"binNumber": "234567",

"assignedUser": "PROG9946014187",

"productCategory": "credit",

"cardType": "commercial credit",

"createdBy": "fino_admin",

Card Management System (CMS) Issuer Interface guide

Integration Document confidential
iServeU pvt ltd © 2023 Page 22 of 121
 "poolAccount": "PROGADMIN",

"customerAccount": "VIRTUAL",

"programManagerAccount": "VIRTUAL",

"allowedPmOrderInventory": false,

"isSelfAssign": false,

"ncmc": false,

"channel":"WEB"

Response Payload:

"statusCode": 0,

"status": "SUCCESS",

"statusDesc": "Bin range added successfully",

"data": {}

6.2.3 Fetch bin Master API:

This API used to fetch all Bin Number using type.

Service Name: https://capidev.iserveu.online

End Point: / card/ fetch_bin_master

Request/Response Fields
Parameter Sub Description Data Mi Ma Mandato Remar
Name Tag Type n x ry ks
Request Payload
type NO type String YES Mandat
(SINGLE,ALL) ory

Card Management System (CMS) Issuer Interface guide

Integration Document confidential
iServeU pvt ltd © 2023 Page 23 of 121
 binNumber NO Bin Number Long NO
(6 digits or 8 digits) Bin
Numbe
r is
mandat
ory for
type
SINGL
E.

channel NO Channel can be ANDROID string

OR WEB Mandat
ory for
all

Response Payload
status NO status id String YES
contains (“-1”: Failed, “0”:
Success)
statusDesc NO status description String YES

binNumber NO Bin Number Long NO

(6 digits or 8 digits)

isActive NO activation status of Bin master Boole NO

(true / false) an

cardBrand NO Card Brand String NO

(RuPay,VISA,Master,CUP,JCB,
DFS)

cardCoBrand NO Card Co-brand String NO

(RuPay,VISA,Master,CUP,JCB,
DFS,NET,
Mercury)
cardSegment NO Card Segment String NO
(prepaid,debit,credit,
closed loop)

cardCategory NO Card Category String NO

(Platinum,Consumer,Corporat
e)

Card Management System (CMS) Issuer Interface guide

Integration Document confidential
iServeU pvt ltd © 2023 Page 24 of 121
 cardVariant NO Card Variant String NO
(Classic,Platinum,Payroll,Gift
,GPR,
Reimbursement,
Corporate Gift,T&E,Business,
Others)

cardBank NO Card Bank String NO

cardServiceC NO Card Service Code String NO

ode

adminName adminName String NO

cardScope NO Card Scope String NO

(International,Domestic)

createdDate NO BIN creation date String NO

updatedDate NO updated Date String NO

Sample API Payload

Request Payload:

{
"type": "SINGLE",
"binNumber": "234567",
"channel": "WEB",

Response Payload:

Card Management System (CMS) Issuer Interface guide

Integration Document confidential
iServeU pvt ltd © 2023 Page 25 of 121
{

"statusCode": 0,

"status": "SUCCESS",

"statusDesc": "Bin master details fetched successfully",

"data": {

"status": "0",

"statusDesc": "Bin Master Details Successfully fetched",

"data": [

"binNumber": "234567",

"isActive": false,

"cardBrand": "RuPay",

"cardCoBrand": "VISA",

"cardSegment": "Credit",

"cardCategory": "Consumer",

"cardVariant": "Corporate Gift",

"cardBank": "Cardbank",

"cardServiceCode": "620",

"adminName": "fino_admin",

"cardScope": "International",

"createdDate": "2024-06-10 15:47:00.384",

"updatedDate": "2024-06-10 15:47:00.384"

Card Management System (CMS) Issuer Interface guide

Integration Document confidential
iServeU pvt ltd © 2023 Page 26 of 121
6.2.4 Fetch bin Range API:
This API used to fetch all Bin Range details using type.

Service Name: https://capidev.iserveu.online

End Point: /card/ fetch_bin_range

Request/Response Fields
Parameter S Description Data Mi M Mandat Rema
Name u Type n ax ory rks
b
Ta
g
Request Payload
type N type Strin YES This is
O (SINGLE,ALL) g to be
SING
LE OR
ALL
assignedUse N Assigned User Name Strin NO Assign
r O g edUse
r is
only
manda
tory
for
type
SINGL
E.
channel N It should be ANDROID OR WEB string NO
O This
is to
be
either
ANDR
OID or
WEB

Response Payload
status N status id Strin YES
O contains (“-1”: Failed, “0”: Success) g
statusDesc N status description Strin YES
O g

Card Management System (CMS) Issuer Interface guide

Integration Document confidential
iServeU pvt ltd © 2023 Page 27 of 121
 binNumber N Bin Number Long NO
O

binRange N Bin Range Long NO

O

isActive N activation status of Bin Range Bool NO

O (true / false) ean

assignedUse N Assigned User Strin NO

r O Name g

productCate N Product Category Strin NO

gory O (GIFT,GPR,CREDIT,SINGLE,MULTI,CL g
OSEDLOOP)

cardType N Card Type Strin NO

O (CHIP,CONTACTLESS, g
MAGSTRIPE)

createdBy N Bin creator Strin NO

O Name g

poolAccount N poolAccount Strin NO

O (PROGADMIN|ISSUER) g

customerAc N customerAccount Integ NO

count O (VIRTUAL|PHYSICAL) er

ncmc N ncmc Strin NO

O g

createdDate N BIN creation date Strin NO

O g

updatedDate N Date Strin NO

O g

Sample API Payload

Request Payload:

Card Management System (CMS) Issuer Interface guide

Integration Document confidential
iServeU pvt ltd © 2023 Page 28 of 121
{

"type": "SINGLE",

"assignedUser": "PROG9946014187",

"channel":"WEB"

Response Payload:
{
"statusCode": 0,
"status": "SUCCESS",
"statusDesc": "Bin range details fetched successfully",
"data": {
"status": "0",
"statusDesc": "BIN details successfully fetched",
"data": [
{
"binRange": 208,
"binNumber": 234567,
"isActive": false,
"assignedUser": "PROG9946014187",
"productCategory": "credit",
"cardType": "commercial credit",
"createdBy": "fino_admin",
"customerAccount": "VIRTUAL",
"ncmc": false,
"createdDate": "2024-06-12 17:02:21.711",
"updatedDate": "2024-06-12 17:02:21.711",
"isSelfAssign": null
}
]
}
}

Card Management System (CMS) Issuer Interface guide

Integration Document confidential
iServeU pvt ltd © 2023 Page 29 of 121
 6.3 User Onboarding Process
6.3.1 User creation
This API will be used to create below users, also allows users to draft user details for further creation
later.
1. Bank admin and its sub-user role
2. Program manager and its sub-user role
3. Corporate and its sub-user role
4. Agent admin and its sub-user role

Note : User will create under requested JWT token in header(Privileges also required check from
JWT)

End Point: user/create_user

Request/Response Field

Parameter Name Sub Description Data Mi Max Mandatory Remarks

Tag Type n
Request Payload
firstName NO first name String 1 50 Y Mandatory for all
scenario and
isSsave is false
lastName NO last name String 1 50 Y Mandatory for all
scenario and
isSsave is false
userName String 1 30 N Mandatory if
isSave is false and
role is
ROLE_AGENT_A
DMIN OR
ROLE_ADMIN
OR a role in which
ROLE_ADMIN
term is present
mobileNumber NO mobile number must be String 10 10 Y Mandatory for all
10 digit unique scenario and isSave
is false
email NO email id must be unique String 1 50 Y Mandatory for all
scenario isSave is
false
designation No designation of the user String 1 400 Y Mandatory for
all except
ROLE_AGENT

Card Management System (CMS) Issuer Interface guide

Integration Document confidential
iServeU pvt ltd © 2023 Page 30 of 121
 _ADMIN and
isSave if false
department NO Department String 1 50 y Mandatory if
isSave is false
and role is
ROLE_ADMIN
dateOfBirth NO date of birth format String 1 10 Y Mandatory for all
should be scenarios isSave is
(YYYY-MM-DD) false
role NO role of the user String 1 300 Y Mandatory if
isSave is false.
roleId NO role id of the user String Y specific id allotted
to the specific role
and Mandatory if
isSave is false
shippingAddress Yes shippingAddress Array Y Mandatory for
of the user of except
objects ROLE_AGENT_A
DMIN and isSave
is false
shippingAddress1 shipping address 1 String 1 255 Y Mandatory for
except
ROLE_AGENT_A
DMIN and isSave
is false
shippingAddress2 shipping address 2 String 1 255 Y Mandatory for
except
ROLE_AGENT_A
DMIN and isSave
is false
shippingCity shipping city String 1 50 Y Mandatory for
except
ROLE_AGENT_A
DMIN and isSave
is false
shippingPincode shippingPincode String 6 6 Y
Mandatory for
except
ROLE_AGENT_A
DMIN and isSave
is false
shippingCountry shippingCountry String 1 50 Y Mandatory for
except
ROLE_AGENT_A
DMIN and isSave
is false
shippingState shippingState String 1 50 Y Mandatory for
except
ROLE_AGENT_A
DMIN and isSave
is false

Card Management System (CMS) Issuer Interface guide

Integration Document confidential
iServeU pvt ltd © 2023 Page 31 of 121
billingAddress YES Billing Address Array N mandatory if isSave
of is false and if
Objects Program manager
or Corporate
Admin
billingAddress1 billingAddress1 String 1 255 N mandatory if isSave
is false and if
Program manager
or Corporate
Admin
billingAddress2 billingAddress2 String 1 255 N mandatory if isSave
is false and if
Program manager
or Corporate
Admin
billingCity billing city String 1 50 N mandatory if isSave
is false and if
Program manager
or Corporate
Admin
billingPincode billingPincode String 6 6 N mandatory if isSave
is false and if
Program manager
or Corporate
Admin
billingCountry billingCountry String 1 50 N mandatory if isSave
is false and if
Program manager
or Corporate
Admin
billingState billing State String 1 50 N mandatory if isSave
is false and if
Program manager
or Corporate
Admin
NO latitude and longitude String Y Mandatory if
latLong of the location isSave is false
channel NO Name of channel, String 1 10 Y It can be either
Contains ANDROID or
(web/Android) WEB and
isSave is false
isSave boole Y It depicts that if
an isSave is true
then it will not be
onboarded rather
it will be just
saved in the
database, if
isSave will be
false then only it
will be
onboarded.

Card Management System (CMS) Issuer Interface guide

Integration Document confidential
iServeU pvt ltd © 2023 Page 32 of 121
cardType NO Must be of either GPR Mandatory if
or GIFT isSave is false
and is either
ROLE_RETAILE
R or
ROLE_RETIAL
ER_SUB
draftedId NO drafted id String N Mandatory only
if updation
category NO category String N Pvt Ltd, Public
Ltd, LLP,
Partnership,

role is either
ROLE_AGENT_
ADMIN,
ROLE_DISTRIB
UTOR or
ROLE_MASTER
_DISTRIBUTOR
and isSave is
false
cin NO Corporate Identification String 21 21 N Mandatory if role
Number of the company are either
ROLE_AGENT_
ADMIN,
ROLE_DISTRIB
UTOR,
ROLEMASTER
DISTRIBUTOR
and isSave is
false
pan NO Private Account String 10 10 N Mandatory if role
Number are
ROLE_ADMIN,
ROLE_MASTER
_DISTRIBUTOR
,ROLE_DISTRI
BUTOR ,
ROLE_AGENT_
ADMIN and
isSave is false
state NO State String 1 50 Y Mandatory if
isSave is false
and role is
ROLE_ADMIN
companyName NO name of the company String 3 160 N Mandatory if role
are
ROLE_AGENT_
ADMIN or
ROLE_DISTRIB
UTOR or
ROLE_MASTER

Card Management System (CMS) Issuer Interface guide

Integration Document confidential
iServeU pvt ltd © 2023 Page 33 of 121
 _DISTRIBUTOR
isSave is false
branchName NO Name of the branch String 1 50 Y Mandatory if
isSave is false
and role is
ROLE_ADMIN
branchAddress NO Address of the branch String 1 500 Y Mandatory if
isSave is false
and role is
ROLE_ADMIN
gstNumber NO gst number String 12 15 N Mandatory if role
are
ROLE_AGENT_
ADMIN or
ROLE_DISTRIB
UTOR or
ROLE_MASTER
_DISTRIBUTOR
isSave is false
productId NO product id Array N Required for
of corporate only
string and isSave is
s false
dateOfIncorporation NO The date on which the String N Mandatory if role
organization was is
formally incorporated ROLE_MASTER
or registered _DISTRIBUTOR
and isSave is
false
clientId NO A unique identifier String N Mandatory if role
assigned to a client at is
time of onboarding ROLE_MASTES
R_DISTRIBUTO
R and isSave is
false
articleofAssociationLink NO A link or reference to String N Mandatory if
the document category are ( Pvt
containing the articles Ltd, Public Ltd)
of association, which orelse role is
outlines the rules and ROLE_MASTER
regulations governing a _DISTRIBUTOR
company's internal
affairs and
management structure.
panLink NO A link or reference to String N Mandatory if
the Permanent Account category is PVT
Number (PAN) LTD, PUBLIC
document LTD ,
ROLE_MASTER
_DISTRI
BUTOR and
isSave is false

Card Management System (CMS) Issuer Interface guide

Integration Document confidential
iServeU pvt ltd © 2023 Page 34 of 121
dueDiligenceFormLink NO A link or reference to String N Mandatory if role
the due diligence form is
used for assessing and ROLE_MASTER
verifying the _DISTRIBUTOR
legitimacy of a and isSave is
business or individual. false

bcagreementformLink NO A link or reference to String N Mandatory if role

the Business is
Correspondent (BC) ROLE-MASTER
agreement form, which _DISTRIBUTOR
outlines the terms and and isSave is
conditions between a false
bank and its business
correspondent.
boardresolutionformLink NO A link or reference to String N Mandatory if role
the board resolution is
form ROLE-MASTER
_DISTRIBUTOR
and isSave is
false
annualreportoflastFYLink NO A link or reference to String N Mandatory if role
the annual report of the is
last financial year, ROLE-MASTER
which provides a _DISTRIBUTOR
comprehensive and isSave is
overview of a false
company's financial
performance and
operations.
auditedfinancialstatementlast2y NO A link or reference to String N Mandatory if role
earLink the audited financial is
statements of the last ROLE-MASTER
two years, _DISTRIBUTOR
and isSave is
false

emdaccountopeningformLink NO A link or reference to String N Mandatory if role

the account opening is
form for Earnest ROLE-MASTER
Money Deposit _DISTRIBUTOR
(EMD), and isSave is
false

kycdocforauthorizedsignatories NO A link or reference to String N Mandatory if role

Link the Know Your is
Customer (KYC) ROLE-MASTER
documents for _DISTRIBUTOR
authorized signatories, and isSave is
which verify their false
identity and address.

Card Management System (CMS) Issuer Interface guide

Integration Document confidential
iServeU pvt ltd © 2023 Page 35 of 121
emdAccountNumber NO The account number String N Mandatory if role
associated with the is
Earnest Money Deposit ROLE_MASTER
(EMD) account. _DISTRIBUTOR
gstRegistrationCertificationLink NO A link or reference to String 500 N Mandatory if Pvt
the Goods and Services Ltd , Public Ltd
Tax (GST) registration and role must not
certification document. be
ROLE_MASTER
_DISTRIBUTOR
and isSave is
false
articleofAssociationLink NO a link or reference to String 500 N Mandatory if Pvt
the document Ltd , Public Ltd
containing the Articles and role is
of Association of a ROLE_MASTER
company _DISTRIBUTOR
and isSave is
false
certificateofIncorporationLink NO A link or reference to String 500 N It is specified to
the certificate of Pvt Ltd or Public
incorporation Ltd OR role is
ROLE_MASTER
_DISTRIBUTOR
memorandumOfAssociationLin NO A link or reference to String 500 N Mandatory if Pvt
k the memorandum of Ltd , Public Ltd
association, which or role is
outlines the company's ROLE_MASTER
objectives, powers, and _DISTRIBUTOR
scope of activities. and isSave is
false
aadhaarPanOfPartnersLink NO A link or reference to String 500 N It is specified to
the Aadhaar and PAN LLP orelse
cards of the partners partnership and
involved in a role must not be
partnership ROLE_MASTER
_DISTRIBUTRO
and isSave is
false
registartionCertificateLink NO A link or reference to String 500 N Mandatory if
the registration category is LLP
certificate, which or
certifies the registration PARTNERSHIP
of a business entity and role must not
with the relevant be
authorities ROLE_MASTER
_DISTRIBUTOR
and isSave is
false
listofDirectorsLink NO A link or reference to String 500 N Mandatory if Pvt
the list of directors of a Ltd , Public Ltd
company, which and role must not
includes details of ROLE_MASTER
_DISTRIBUTOR

Card Management System (CMS) Issuer Interface guide

Integration Document confidential
iServeU pvt ltd © 2023 Page 36 of 121
 individuals serving on and isSave is
the board of directors. false
listofPartnersLink NO A link or reference to String 500 N It is specified to
the list of partners LLP or else
involved in a partnership and
partnership business role must not be
ROLE_MASTER
_DISTRIBUTOR
and isSave is
false
partnershipDeedLink NO A link or reference to String 500 N It is specified to
the partnership deed, LLP orelse
which outlines the partnership and
terms and conditions role must not be
governing the ROLE_MASTER
partnership agreement. _DISTRIBUTOR
and isSave is
false
aadhaarAndPanAuthorisedSignatories NO A link or reference to String 500 N It is specified to
Link the Aadhaar and PAN Pvt Ltd or Public
cards of authorized Ltd and must not
signatories representing be of role
a company or ROLE_MASTER
organization _DISTRIBUTOR
and isSave is
false
Response Payload
status No Status of the performed String Y
action. E.g. –
SUCCESS or FAILED
statusCode No This field describes the Intege Y
Status Code of a r
performed Action. Eg-
success (0), failed
(1),failed(-1) for token
authorization failed
statusDesc No Description of the String N
status of the performed
action
data No Description of the object Y
Other service

Sample API Payload

Request Payload:

{
"firstName": "Shaktiman",
"lastName": "subudhi",
"mobileNumber": "9946014187",

Card Management System (CMS) Issuer Interface guide

Integration Document confidential
iServeU pvt ltd © 2023 Page 37 of 121
 "email": "shaktimansubudhi@yopmail.com",
"designation": "hhhhh",
"dateOfBirth": "1999-10-12",
"role": "ROLE_MASTER_DISTRIBUTOR_MAKER_SUB",
"roleId": "9",
"shippingAddress": [
{
"shippingAddress1": "bbsr",
"shippingAddress2": "bbsr",
"shippingCity": "bbsr",
"shippingCountry": "india",
"shippingPincode": "752030",
"shippingState": "odisha"
}
],
"createdBy": "PROG9566619442",
"channel": "WEB", // Add your validation rules for channel her
"latLong": "34.45.567",
"isSave":true,
"draftedId":"6628fdcf4611bd36534b"
}

Success Response Payload:

{
{
"statusCode": 0,
"status": "SUCCESS",
"statusDesc": "User created successfully",
"data": {
"id": "4444490000028986",
"status": "INITIATED",
"statusDesc": "Onboarded at User Mangement",
"substatus": 1,
"username": "PROG9946014437",
"adminId": "4444430000028953",
"adminRole": "ROLE_MASTER_DISTRIBUTOR",
"adminName": "PROG9566619442"
}
}

Failed Response Payload:

{
"statusCode": 1,
"status": "FAILED",
"statusDesc": "Failed to update user",
"data": {
"stringValue": "\"6628fdcf4611bd36534b\"",
"valueType": "string",
"kind": "ObjectId",
"value": "6628fdcf4611bd36534b",

Card Management System (CMS) Issuer Interface guide

Integration Document confidential
iServeU pvt ltd © 2023 Page 38 of 121
 "path": "_id",
"reason": {},
"name": "CastError",
"message": "Cast to ObjectId failed for value \"6628fdcf4611bd36534b\" (type string) at
path \"_id\" for model \"userDetails\""
}
}

6.3.2 Customer creation API

This API will be used to create a customer or sub customer.

This API will also be used to edit the drafted user .

here you will use the drafted Id (i.e got from the fetch user api )

To update the drafted user you just will pass "isSave": true,

To finally create the user you will pass "isSave": false along with the other details

sample example attached below

Base url: https://capidev.iserveu.online

End Point: user/create_customer

Request/Response Field

Parameter Name Sub Tag Description Data Type Min Max Mandatory Remarks
Request Payload
firstName No First Name String 1 50 Y
Mandator
y for all

scenario
lastName No Last Name String 1 50 Y
Mandator
y for all

scenario
mobileNumber No mobile number String 10 10 Y
must be 10 digit Mandator
unique y for all

Card Management System (CMS) Issuer Interface guide

Integration Document confidential
iServeU pvt ltd © 2023 Page 39 of 121
 scenario
email No email Id must String 1 50 Y
be unique Mandator
y for all

scenario
role No role of the String 1 300 Y Mandatory
customer while
creating
corporate
roleId No role id of the String Y specific id
customer allotted
to the
specific
role
latLong No latitude and String Y it fetches
longitude of the the ip
location from the
location it
is used
isSave No Aboolean value boolean Y Mandato
i.e True or False ry
cardType No Card type String Y Only
mandator
y while
creating
customer
relationship No String Y Only
mandator
y while
creating
child
customer
draftedId No String Y its
mandator
y while
updation
channel No Name of String 1 10 Y It can be
channel, either
Contains ANDROID
(web/Android) or WEB
Response Payload
status No Status of the String Y
performed
action. E.g. –
SUCCESS or
FAILED
statusCode No This field Integer Y
describes the
Status Code of a
performed

Card Management System (CMS) Issuer Interface guide

Integration Document confidential
iServeU pvt ltd © 2023 Page 40 of 121
 Action. Eg-
success (0),
failed
(1),failed(-1) for
token
authorization
failed
statusDesc No Description of String N
the status of the
performed
action
data No Description of object Y
the FINO

To update the drafted user

Request Payload:

"firstName": "TestCustomerRabibhaiiiiii",

"lastName": "Nayak",

"mobileNumber": "7787994657",

"email": "testcustomerrabi@yopmail.com",

"cardType":"CLC",

"role": "ROLE_RETAILER",

"roleId": "5",

"channel": "WEB",

"latLong": "34.45.567",

"isSave": true,

"draftedId":"66726bdba3ff10b40f39223f"

Success Response Payload:

Card Management System (CMS) Issuer Interface guide

Integration Document confidential
iServeU pvt ltd © 2023 Page 41 of 121
 "statusCode": 0,

"status": "SUCCESS",

"statusDesc": "Document updated successfully",

"data": {}

To create the user(onboard the user)

Request Payload:

"firstName": "TestCustomerRabibhaiiiiii",

"lastName": "Nayak",

"mobileNumber": "7787994657",

"email": "testcustomerrabi@yopmail.com",

"cardType":"CLC",

"role": "ROLE_RETAILER",

"roleId": "5",

"channel": "WEB",

"latLong": "34.45.567",

"isSave": false,

"draftedId":"66726bdba3ff10b40f39223f"

Success Response Payload:

Card Management System (CMS) Issuer Interface guide

Integration Document confidential
iServeU pvt ltd © 2023 Page 42 of 121
 "statusCode": 0,

"status": "SUCCESS",

"statusDesc": "User created successfully",

"data": {

"id": "4444450000030091",

"status": "PENDING",

"statusDesc": "Onboarded at User Mangement",

"substatus": 1,

"username": "CUST7787994657",

"adminId": "44444",

"adminRole": "ROLE_ADMIN",

"adminName": "fino_admin"

Failed Response Payload:

“statusCode” : 0,

“status” : “FAILED”,

“statusDesc”: “Error in creating customer”,

“data” : specific error

6.3.3 Delete Draft User API

This API will be used to delete users from Draft only.
End Point: user/delete_user
Request/Response Field

Card Management System (CMS) Issuer Interface guide

Integration Document confidential
iServeU pvt ltd © 2023 Page 43 of 121
Parameter Name Sub Tag Description Data Type Min Max Mandatory Remarks
Request Payload
userDocId No MongoDB Id of String Y Mandato
User ry
channel No Name of String 1 10 Y Mandator
channel, y With
Contains the only
(web/Android) value
which is
present
in the
bracket
Response Payload
status No Status of the String Y
performed
action. E.g. –
SUCCESS or
FAILED
statusCode No This field Integer Y
describes the
Status Code of a
performed
Action. Eg-
success (0),
failed
(1),failed(-1) for
token
authorization
failed
statusDesc No Description of String N
the status of the
performed
action
data No Description of object Y
the FINO

Sample API Payload

Request Payload:
{
"userDocId": "66726bdba3ff10b40f39223f",
"channel": "WEB"
}

Success Response Payload:

{

Card Management System (CMS) Issuer Interface guide

Integration Document confidential
iServeU pvt ltd © 2023 Page 44 of 121
 "statusCode": 0,
"status": "SUCCESS",
"statusDesc": "User deleted successfully",
"data": {
"acknowledged": true,
"deletedCount": 1
}
}
Failed Response Payload:
{
“statusCode” : 1,
“status”: “FAILED”,
“statusDesc”: “Failed to delete user”,
“data”:specific error
}

6.3.4 Update User API

This API will be used to update approved users details .
End Point: user/update_user
Request/Response Field

Parameter Name Sub Tag Description Data Type Min Max Mandatory Remarks
Request Payload
_id No MongoDB Id of String Y
User
data Yes Data to be Object Y Whateve
updated r data
provided
will be
updated
against
the
provided
_id
channel No Name of String 1 10 Y Mandator
channel, y with the
Contains only
(web/Android) value
which is

Card Management System (CMS) Issuer Interface guide

Integration Document confidential
iServeU pvt ltd © 2023 Page 45 of 121
 present in
bracket
Response Payload
status No Status of the String Y
performed
action. E.g. –
SUCCESS or
FAILED
statusCode No This field Integer Y
describes the
Status Code of a
performed
Action. Eg-
success (0),
failed
(1),failed(-1) for
token
authorization
failed
statusDesc No Description of String N
the status of the
performed
action
data No Description of object Y
the FINO

Sample API Payload

Request Payload:

"_id": "6672b33544b87d029c9eb8d1",

"data": {

"firstName": "Samtestnew",

"lastName": "Baral",

"channel":"WEB"

},

Card Management System (CMS) Issuer Interface guide

Integration Document confidential
iServeU pvt ltd © 2023 Page 46 of 121
 "channel":"WEB"

Success Response Payload:

"statusCode": 0,

"status": "SUCCESS",

"statusDesc": "User updated successfully",

"data": {}

Failed Response Payload:

"statusCode": 1,

"status": "FAILED",

"statusDesc": "Failed to update user",

"data": {}

6.3.5 Fetch User API

This API will be used to fetch users.

End Point: user/fetch_user

Request/Response Field

Card Management System (CMS) Issuer Interface guide

Integration Document confidential
iServeU pvt ltd © 2023 Page 47 of 121
 Parameter Sub Description Data Min Max Mandatory Remarks
Name Tag Type

Request Payload

status No Status can be String Y ALL - to

APPROVED", fetch all
"PENDING", data
"REJECTED", DRAFT - to
"DRAFT", "ALL
fetch save
and
continue
data

role No Role String Y Role of the

login user

requestingRole No role which parent String Y Mandatory

user want to see

channel No Name of channel, String 1 10 Y Only given

Contains value allow
(web/Android) which is
present in
bracket

Response Payload

status No Status of the String Y

performed action.
E.g. – SUCCESS or
FAILED

statusCode No This field describes Integer Y

the Status Code of
a performed
Action. Eg- success
(0), failed
(1),failed(-1) for
token

Card Management System (CMS) Issuer Interface guide

Integration Document confidential
iServeU pvt ltd © 2023 Page 48 of 121
 authorization
failed

statusDesc No Description of the String N

status of the
performed action

data No Description of the object Y

FINO

Sample API Payload

For CIS-375
“role” : ”ROLE_ADMIN_MAKER_OPS_SUB ”,

For CIS-285
“role” : ”ROLE_MASTER_DISTRIBUTOR_MAKER_SUB”

For CIS-340
“role”: “ROLE_DISTRIBUTOR_MAKER_SUB”

Request Payload:
{

"status": "DRAFT",

"role": "ROLE_ADMIN_MAKER_OPS_SUB",

"requestingRole": ["ROLE_RETAILER"],

"channel": "WEB"

Card Management System (CMS) Issuer Interface guide

Integration Document confidential
iServeU pvt ltd © 2023 Page 49 of 121
Success Response Payload:

"statusCode": 0,

"status": "SUCCESS",

"statusDesc": "User fetched successfully",

"data": [

"Id": "66726bdba3ff10b40f39223f",

"firstName": "TestCustomerRabi",

"lastName": "Nayak",

"latLong": "34.45.567",

"mobileNumber": 7787994657,

"email": "testcustomerrabi@yopmail.com",

"admin_id": "44444",

"admin_name": "fino_admin",

"admin_role": "ROLE_ADMIN",

"corporate_id": "",

"corporate_name": "",

"corporate_role": "",

"program_manager_id": "",

"program_manager_name": "",

"program_manager_role": "",

"creator_id": "44444120000029056",

"createdBy": "MAKERNIKHIL",

"creatorRole": "ROLE_ADMIN_MAKER_OPS_SUB",

"created_date": "2024-06-19T05:25:47.000Z",

"updated_date": "2024-06-19T05:25:47.000Z",

Card Management System (CMS) Issuer Interface guide

Integration Document confidential
iServeU pvt ltd © 2023 Page 50 of 121
 "role": "ROLE_RETAILER",

"status": "INITIATED",

"statusDesc": "Customer Creation pending",

"userId": "",

"clientId": "",

"companyName": "",

"subStatus": 0,

"approverId": "",

"productId": [],

"shippingAddress": [],

"billingAddress": [],

"isActive": false,

"isApprove": false

Failed Response Payload:

“statusCode”:1,

“status”: ”FAILED”,

“statusDesc”: “User not found”,

“data”: {}

6.3.6 Approve User API

This API will be used to approve users.
End Point: user/approve_user
Request/Response Field

Card Management System (CMS) Issuer Interface guide

Integration Document confidential
iServeU pvt ltd © 2023 Page 51 of 121
Parameter Name Sub Tag Description Data Type Min Max Mandatory Remarks
Request Payload
user_name No User name String 1 50 Y Mandato
ry
isApprove No Role Boolean Y Mandato
ry
remarks No Remarks String Y Explanat
ion kind
behind
approval
or
rejection
approvedBy No Approver name String 1 50 Y Mandato
ry
pan No Pan number String Optional
for the
time.
channel No Name of String 1 10 Y Only
channel, given
Contains value
(web/Android) allow
which is
present in
bracket
Response Payload
status No Status of the String Y
performed
action. E.g. –
SUCCESS or
FAILED
statusCode No This field Integer Y
describes the
Status Code of a
performed
Action. Eg-
success (0),
failed
(1),failed(-1) for
token
authorization
failed
statusDesc No Description of String N
the status of the
performed
action
data No Description of object Y
the FINO

Sample API Payload

Card Management System (CMS) Issuer Interface guide

Integration Document confidential
iServeU pvt ltd © 2023 Page 52 of 121
Request Payload:
{
"user_name": "CORP6370079763",
"isApprove": true,
"remarks": "Approve",
"approvedBy": "BANKCHECKERSOMUUU",
"channel": "WEB",
"pan":"ABXDE3795F"
}

Success Response Payload:

"statusCode": 0,

"status": "SUCCESS",

"statusDesc": "user approved successfully",

"data": {

"status": "0",

"statusDesc": "Parent User Created"

Failed Response Payload:

"statusCode": 1,

"status": "FAILED",

"statusDesc": "User can not access this action",

"data": {}

Card Management System (CMS) Issuer Interface guide

Integration Document confidential
iServeU pvt ltd © 2023 Page 53 of 121
 6.3.7 Self Sign Up API

This API will be used for the self sign up process.

Process

Self sign up process involves two ways

1.Self-signup with Card Reference Number:

In this method, users initiate the self-signup process using a unique card reference number provided
by the administrator. The user enters the card reference number during the signup process to
authenticate and associate themselves with the provided card.
2.Self-signup without Card Reference Number (Admin Referral):
In this method, users initiate the self-signup process without requiring a specific card reference
number. The system may include validation steps to verify the legitimacy of the referral before
allowing the user to complete the signup process.

End Point: FinoprepaidCard/self_signup

Request/Response Fields

Parameter Name Sub Tag Description Data Type Min Ma Mandator Remarks
x y
Request Payload
firstName NO first name String 1 50 N mandator
y
lastName NO last name String 1 50 N mandator
y
gender NO gender String 1 10 N mandator
(M/F) y for
GPR
cardType
dateOfBirth NO date of birth String 1 10 N mandator
(YYYY-MM-DD) y for
GPR
cardType
address NO address String 1 255 N mandator
y for
GPR
cardType
address1 NO additional address String 1 255 N mandator
y for
GPR
cardType
city NO city name String 1 50 N mandator
y for

Card Management System (CMS) Issuer Interface guide

Integration Document confidential
iServeU pvt ltd © 2023 Page 54 of 121
 GPR
cardType
pincode NO pin code Integer 6 6 N mandator
y for
GPR
cardType
state NO state name String 1 50 N mandator
y for
GPR
cardType
country NO country name String 1 50 N mandator
y for
GPR
cardType
latlong NO latitude and longitude String 1 255 Y mandator
y
mobileNumber NO mobile number must be 10 String 10 10 Y mandator
digit unique y
email NO email id must be unique String 1 50 Y mandator
y
kycType NO OVD types should be String 1 50 N mandator
aadhar, pan, passport, etc.. y for
GPR
cardType
kycNumber NO OVDnumber String 1 50 N mandator
(alphanumeric) y for
GPR
cardType
channel NO channel String 1 10 Y mandator
either be WEB / ANDROID y
remarks NO any remarks String 1 255 N optional
cardType NO card type should be either String N mandator
PREPAID or GIFT y
kycStatus NO kyc status should be String 1 10 N mandator
MIN-KYC or FULL-KYC y for
GPR
cardType
cardRefNo NO unique card reference String 10 12 N mandator
number y for
withcard
ref no for
selfsigno
n
createdBy NO creator name String 1 50 Y mandator
y
creatorRole NO creator role String 1 50 Y mandator
y
approvedBy NO approver name String 1 255 N optional
approverRole NO approver role String 1 255 N optional
Response Payload
status No Status of the performed String Y
action. E.g. – SUCCESS or
FAILED

Card Management System (CMS) Issuer Interface guide

Integration Document confidential
iServeU pvt ltd © 2023 Page 55 of 121
statusCode NO This field describes the Integer Y
Status Code of a performed
Action. Eg- success (0),
failed (1),failed(-1) for token
authorization failed
statusDesc No Description of the status of String N
the performed action
data No Description of the CMS Object Y

Sample API Payload

Request Payload for :

Request Payload (gift with card)

{
"firstName": "kotaGoutam",
"lastName": "Senapaty",
"latlong": "40.7128° N, 74.0060° W",
"mobileNumber": "6370098659",
"email": "amusarkar@yopmail.com",
"channel": "WEB",
"cardType": "GIFT",
"cardRefNo": "2111000023",
"createdBy": "CORP8763112029",
"creatorRole": "CORP_ADMIN"
}

Request Payload (gift without card)

{
"firstName": "kotaGoutam",
"lastName": "Senapaty",
"latlong": "40.7128° N, 74.0060° W",
"mobileNumber": "6370098659",
"email": "amusarkar@yopmail.com",
"channel": "WEB",
"cardType": "GIFT",
"createdBy": "CORP8763112029",
"creatorRole": "CORP_ADMIN"
}

Request Payload (GPR WITH CARD)

{
"firstName": "Biswajit",
"lastName": "Sahoo",
"gender": "M",
"dateOfBirth": "2002-05-07",
"address": "infocity",
"address1": "BBSR",
"city": "Bhubaneswar",
"pincode": 754219,
"state": "Odisha",

Card Management System (CMS) Issuer Interface guide

Integration Document confidential
iServeU pvt ltd © 2023 Page 56 of 121
 "country": "India",
"latlong": "40.7128° N, 74.0060° W",
"mobileNumber": "9348909448",
"email": "eicuser5@yopmail.com",
"kycType": "AADHAR",
"kycNumber": "651387781753",
"cardRefNo":"2111000116",
"channel": "WEB",
"remarks": "tttt",
"cardType": "GPR",
"kycStatus": "MIN-KYC",
"createdBy": "CORP8763112029",
"creatorRole": "CORP_ADMIN"
}

Request Payload (GPR WITHOUT CARD)

{
"firstName": "Neha",
"lastName": "Sahoo",
"gender": "F",
"dateOfBirth": "2002-05-07",
"address": "infocity",
"address1": "BBSR",
"city": "Bhubaneswar",
"pincode": 754219,
"state": "Odisha",
"country": "India",
"latlong": "40.7128° N, 74.0060° W",
"mobileNumber": "9348909411",
"email": "sakibkumar@yopmail.com",
"kycType": "AADHAR",
"kycNumber": "651387781711",
"channel": "WEB",
"remarks": "tttt",
"cardType": "GPR",
"kycStatus": "MIN-KYC",
"createdBy": "CORP8763112029",
"creatorRole": "CORP_ADMIN"
}

Success Response Payload:

{
"statusCode": 0,
"status": "SUCCESS",
"statusDesc": "Customer created successfully",
"data": {
"ResponseCode": 0,
"MessageString": "OTP Generation Successful",
"ClientInitiatorId": "",
"RequestID": "1233323731032481792_0426202413181297",

Card Management System (CMS) Issuer Interface guide

Integration Document confidential
iServeU pvt ltd © 2023 Page 57 of 121
 "ClientRefID": "1233323731032481792",
"ResponseData": {
"ResponseCode": 0,
"MessageString": "OTP Generation Successful",
"ClientUniqueID": "1233323731032481792",
"ClientInitiatorId": "",
"RequestID": "1233323731032481792_0426202413181297",
"ResponseData": {
"ReferenceID": "826918",
"RFU1": "",
"RFU2": "",
"RFU3": ""
}
},
"userId": "4444450000000197"
}
}

Failed Response Payload:

{
"statusCode": 1,
"status": "FAILED",
"statusDesc": "Customer creation failed",
"data": {}
}

6.3.8 Verify Sign Up API

This API will be used to verify the self sign up process.
End Point: FinoprepaidCard/verify_self_signup
Request/Response Fields

Parameter Sub Tag Description Data Type Min Ma Mandator Remar

Name x y ks
Request Payload
otp NO Generated otp After String 4 6 Y Receive
Successful sign up d from
CMS
customerId NO customer id String 16 23 Y You will
get from
respons
e of
selfsign
on API
cardRefNo NO card reference number String 10 12 N
referenceId NO reference id String 1 Y You will
get from
respons
e
referen

Card Management System (CMS) Issuer Interface guide

Integration Document confidential
iServeU pvt ltd © 2023 Page 58 of 121
 ceId of
selfsign
On API
channel NO channel String 1 10 Y This is
either be WEB / ANDROID to be
either
ANDR
OID or
WEB
Response Payload
status No Status of the performed String Y
action. E.g. – SUCCESS or
FAILED
statusCode NO This field describes the Status Integer Y
Code of a performed Action.
Eg- success (0), failed
(1),failed(-1) for token
authorization failed
statusDesc No Description of the status of the String N
performed action
data No Description of the CMS Object Y

Sample API Payload

Request Payload:

{
"otp": “4145”,
"customerId":"3",
"cardRefNo": “2111000011”,
"referenceId": “815842”,
"channel": "WEB"
}

Success Response Payload:

{
"statusCode": 0,
"status": "SUCCESS",
"statusDesc": "Customer verified successfully",
"data": {}
}

Failed Response Payload:

{
"statusCode": 1,
"status": "FAILED",
"statusDesc": "Unable to verify Customer!! Try again after sometime..",
"data": {}
}

Card Management System (CMS) Issuer Interface guide

Integration Document confidential
iServeU pvt ltd © 2023 Page 59 of 121
 6.3.9 User Activation API
This API will be used to activate or deactivate the user.
End Point: user/activate_user

Request/Response Fields

Parameter Sub Tag Description Data Type Min Ma Mandator Remar

Name x y ks
Request Payload
userName NO user name of the user which String 1 50 Y Mandat
will be activated or ory
deactivated
isActive NO true for activating the user, Boolean Y Mandat
false for deactivating the user ory
channel NO channel String 1 10 Y This is
either be WEB / ANDROID to be
either
ANDR
OID or
WEB
Response Payload
status No Status of the performed String Y
action. E.g. – SUCCESS or
FAILED
statusCode NO This field describes the Status Integer Y
Code of a performed Action.
Eg- success (0), failed
(1),failed(-1) for token
authorization failed
statusDesc No Description of the status of the String N
performed action
data No Object Y Blank
object
sent

Sample API Payload

Request Payload:
{
"userName": "PROG9946013787",
"isActive": true,
"channel": "WEB"
}

Card Management System (CMS) Issuer Interface guide

Integration Document confidential
iServeU pvt ltd © 2023 Page 60 of 121
Success Response Payload:
{
"statusCode": 0,
"status": "SUCCESS",
"statusDesc": "user activated successfully",
"data": {}
}

Failed Response Payload:

{
"statusCode": 1,
"status": "FAILED",
"statusDesc": "User not found",
"data": {}
}

6.3.10 Existing Customer Onboarding API

This API will be used to onboard existing customers.
End Point: /user/existing_customer_onboarding

Request/Response Fields

Parameter Sub Tag Description Data Min Max Mandator Remark

Name Type y

Request Payload

mobileNumber No mobile number string 10 10 Y Mandat

must be 10 digit ory for
unique fetchin
g
details

cardRefNo No unique card string 10 10 Y Mandat

reference number ory
being
unique

cardType No card type should be string N Must be

either GPR or
PREPAID or GIFT GIFT

Response Payload

status Status of the string Y

performed action.
E.g. – SUCCESS or
FAILED

Card Management System (CMS) Issuer Interface guide

Integration Document confidential
iServeU pvt ltd © 2023 Page 61 of 121
 statusCode This field describes integer Y
the Status Code of
a performed
Action. Eg- success
(0), failed
(1),failed(-1) for
token authorization
failed

statusDesc Description of the string N

status of the
performed action

data Response of the Y

CMS API

Sample API Payload

Request Payload:

{
"mobileNumber":"9937790148",
"cardRefNo":"2111000023",
"cardType":"GPR"
}

Response Payload:

{
"statusCode": "0",
"status": "SUCCESS",
"statusDesc": "Existing customer onboarded successfully",
"data": {
"statusCode": 0,
"status": "SUCCESS",
"statusDesc": "Customer created successfully",
"data": {
"ResponseCode": 0,
"MessageString": "OTP Generation Successful",
"ClientInitiatorId": "",
"RequestID": "1242741999556108288_0522202413030467",
"ClientRefID": "1242741999556108288",
"ResponseData": {
"ResponseCode": 0,
"MessageString": "OTP Generation Successful",
"ClientUniqueID": "1242741999556108288",
"ClientInitiatorId": "",

Card Management System (CMS) Issuer Interface guide

Integration Document confidential
iServeU pvt ltd © 2023 Page 62 of 121
 "RequestID": "1242741999556108288_0522202413030467",
"ResponseData": {
"ReferenceID": "839727",
"RFU1": "",
"RFU2": "",
"RFU3": "",
},
},
"userId": "4444450000029152",
},
},
};

Failed Response Payload:

{
"statusCode": 1,
"status": "FAILED",
"statusDesc": "Error while executing selfsignup",
"data": specific error
}

6.3.11 Profile Details Fetch API:

This API will be used to fetch profile details of the user.

End Point: /apiuser/user/profile_details_fetch

Request/Response Fields

Parameter Sub Description Data Min Max Man Rema

Name Tag type dato rks
ry

Request Payload

mobileNumber mobile number must be string 10 10 Y Manda

10 digit unique tory
for all

otp Generated otp After string 4 6 Y Manda

Successful sign up tory

params string Y Manda

tory

channel Must be ANDROID or string 1 10 Y Manda

WEB tory
for all
with
the
value

Card Management System (CMS) Issuer Interface guide

Integration Document confidential
iServeU pvt ltd © 2023 Page 63 of 121
 which
is
given
in the
bracke
t

Response Payload
status Status of the performed string Y
action. E.g. – SUCCESS
or FAILED

statusCode This field describes the integer Y

Status Code of a
performed Action. Eg-
success (0), failed
(1),failed(-1) for token
authorization failed

statusDesc Description of the status string N

of the performed action

data Response of the CMS Y

API

Sample request:
{
"mobileNumber": "9337764181",
"otp": "8919",
"channel": "WEB",
"params": "CARDOTP2"

Success Sample response:

{
"statusCode": 0,
"status": "SUCCESS",
"statusDesc": "Successfully verified the user for view",
"data": {
"email": "subratparida@yopmail.com",
"kycType": "MIN-KYC",
"userName": "CUST9337764181",
"name": "Rohit Nanda",
"mobileNumber":"9337764181"

Card Management System (CMS) Issuer Interface guide

Integration Document confidential
iServeU pvt ltd © 2023 Page 64 of 121
 }

Failed Response Payload:

{
"statusCode": 1,
"status": "FAILED",
"statusDesc": "Error while receiving response",
"data": specific error
}
6.3.12 Otp Generation API
This API will be used to generate OTP.

Base Url : https://capidev.iserveu.online

End Point: user/generate_otp_for_customer

Request/Response Fields

Parameter Name Sub Description Data Min Max Mandat Remarks

Tag Type ory

Request Payload

mobileNumber No mobile number String 10 10 Y Mandatory

must be 10 digit for all
unique
scenario

params No Same value need string Y Mandatory

to be passed at
the time of
verification OTP

cardType NO Card type, 'GIFT', String Y mandatory

'GPR', 'SINGLE',
'MULTI',
'CREDIT',”CLC”

Card Management System (CMS) Issuer Interface guide

Integration Document confidential
iServeU pvt ltd © 2023 Page 65 of 121
data Yes Fields that need Object N only
to be mandatory
updated/upgrad for GPR,
ed SINGLE,
MULTIand
CREDITcard
AND CLC

kycType NO PAN, String 1 50 N Mandatory

AADHAR for GPR or
credit card or
DL, CLC
NAREGA

kycNumber NO Document String 1 50 N Mandatory

Number for GPR or
CREDIT
CARD or
CLC

aadhaarLink No Aadhaar String 1 500 N Mandatory

for single/
multi
currency
card

panLink No A link or String 1 500 N Mandatory

reference to for single/
the Permanent multi
Account currency
Number (PAN) card
document

airlineTicketLink No Airline Ticket String 1 500 N Mandatory

for single/
multi
currency
card

visaLink No Visa String 1 500 N Mandatory

for single/
multi
currency
card

Card Management System (CMS) Issuer Interface guide

Integration Document confidential
iServeU pvt ltd © 2023 Page 66 of 121
 passportLink No Passport String 1 500 N Mandatory
for single/
multi
currency
card

dateOfBirth NO date of birth String 1 10 N Mandatory

format should be for credit
(YYYY-MM-DD) and GPR
CARD
and CLC

gender No Gender can be in String N Mandatory

Male Female or for
Other CREDIT
CARDor
GPR card
or CLC

employment No 1.Salaried String N Mandatory

for credit
2.Self-employed card
3.Business
Owner

4.Unemployed

product No Product String N Mandatory

for credit
card

losProduct No Los Product String N Mandatory

for credit
card

address No shipping address String 1 255 N Mandatory

address1 No shipping address String 1 255 N Mandatory

1 for GPR or

Card Management System (CMS) Issuer Interface guide

Integration Document confidential
iServeU pvt ltd © 2023 Page 67 of 121
 CLC or
CREDIT

city No shipping city String 1 50 N Mandatory

for GPR
CARD or
CLC or
CREDIT
CARD

pincode No shippingPincode String 6 6 N 6 digits Valid

pin code,

Mandatory
for GPR
CARD or CLC
or CREDIT
CARD

country No shippingCountry String 1 50 N Mandatory

for GPR
CARD or
CLC or
CREDIT
CARD

state No shippingState String 1 50 N Mandatory

for GPR
CARD or
CLC or
CREDIT
CARD

channel No WEB/ANDRO String 1 10 Y

ID

Response Payload

status No Status of the String Y

performed
action. E.g. –
SUCCESS or
FAILED

Card Management System (CMS) Issuer Interface guide

Integration Document confidential
iServeU pvt ltd © 2023 Page 68 of 121
 statusCode No This field Intege Y
describes the r
Status Code of
a performed
Action. Eg-
success (0),
failed
(1),failed(-1)
for token
authorization
failed

statusDesc No Description of String N

the status of
the performed
action

data No Description of object Y

the Other
service

Sample API Payload

Request Payload for GIFT:

"params": "niyati",

"cardType":"GIFT",

"channel": "WEB"

Request Payload for GPR:

"mobileNumber": "7787994297",

"params": "alokbhai",

"cardType":"GPR",

"channel":"WEB",

Card Management System (CMS) Issuer Interface guide

Integration Document confidential
iServeU pvt ltd © 2023 Page 69 of 121
"data": {

"kycType": "AADHAR",

"kycNumber": "123456723125",

"address": "bbsr",

"address1": "bbsr",

"city": "bbsr",

"country": "india",

"pincode": "752030",

"state": "odisha",

"dateOfBirth": "1999-10-12",

"gender": "Male",

Request Payload for Single/ Multi currency card:

"mobileNumber": "8249652456",

“params”: “hello”,

“cardType”:”SINGLE”

"channel":"WEB",

"data": {

“aadhaarLink”: “”,

“panLink”: “”,

“airlineTicketLink”: “”,

“visaLink”: “”,

“passportLink”: “”

Card Management System (CMS) Issuer Interface guide

Integration Document confidential
iServeU pvt ltd © 2023 Page 70 of 121
Request Payload for Credit card:

"mobileNumber": "8249652456",

“params”: “hello”,

“cardType”:”CREDIT”

"channel":"WEB",

"data": {

"kycType": "AADHAR",

"kycNumber": "123456723125",

"address": "bbsr",

"address1": "bbsr",

"city": "bbsr",

"country": "india",

"pincode": "752030",

"state": "odisha",

"dateOfBirth": "1999-10-12",

"gender": "Male",

“employment”: “salaried”,

“product”: “testproduvct”,

“losProduct”: “testlosproduct”,

Success Response Payload:

"statusCode": 0,

"status": "SUCCESS",

Card Management System (CMS) Issuer Interface guide

Integration Document confidential
iServeU pvt ltd © 2023 Page 71 of 121
 "statusDesc": "OTP Generated Successfully",

"data": {

"status": "0",

"statusDesc": "Otp Successfully send to *******297"

Failed Response Payload:

{
"statusCode": 1,
"status": "FAILED",
"statusDesc": "Failed to generate otp",
"data": whatever data received
}

6.3.13 Otp Verification API

This API will be used to verify otp.

Base Url : https://capidev.iserveu.online

End Point: user/otp_verification

Request/Response Field

Parameter Su Description Data Mi Ma Mandator Remarks

Name b Type n x y
Tag

Request Payload

mobileNumb NO mobile number must be String 10 10 Y Mandatory

er 10 digit unique for all

scenario

Card Management System (CMS) Issuer Interface guide

Integration Document confidential
iServeU pvt ltd © 2023 Page 72 of 121
 params No params String Y Mandator
y

otp No otp Numeri 4 6 Y

c Mandator
y

cardType No Card type must be in String Y Mandator

between(GIFT, y
GPR,SINGLE,MULTI,CREDI
T, CLC)

channel No Name of channel, String 1 10 Y Only given

Contains (WEB / value allow
ANDROID) which is
present in
bracket

Response Payload

status No Status of the performed String Y

action. E.g. – SUCCESS or
FAILED

statusCode No This field describes the Integer Y

Status Code of a
performed Action. Eg-
success (0), failed
(1),failed(-1) for token
authorization failed

statusDesc No Description of the status String N

of the performed action

data No Description of the otp object Y

verification

Card Management System (CMS) Issuer Interface guide

Integration Document confidential
iServeU pvt ltd © 2023 Page 73 of 121
Sample API Payload

Request Payload:

"mobileNumber": "8617295228",

"params": "niyati",

"otp": "9939",

"cardType":"GIFT",

"channel": "WEB"

Success Response Payload:

"statusCode": 0,

"status": "SUCCESS",

"statusDesc": "Otp Verified Successfully",

"data": {

"status": "0",

"statusDesc": "Otp Verified Successfully"

Failed Response Payload:

{

Card Management System (CMS) Issuer Interface guide

Integration Document confidential
iServeU pvt ltd © 2023 Page 74 of 121
 "statusCode": 1,
"status": "FAILED",
"statusDesc": "User not found",
"data": {}
}
6.3.14 Status check API
This API will be used to check the status of the user.

Base Url : https://capidev.iserveu.online

End Point: user/card_status_check

Request/Response Fields

Parameter Name Sub Description Data Min Max Mandatory Remarks

tag Type

Request Payload

mobileNumber No mobile String 10 10 Y Mandatory

number must for all
be 10 digit
unique scenario

channel No It’s the String Y Mandatory

channel.(WE with the
B/ value
ANDROID) which is
given in
the bracket

Response Payload

status No Status of the String Y

performed
action. E.g. –
SUCCESS or
FAILED

Card Management System (CMS) Issuer Interface guide

Integration Document confidential
iServeU pvt ltd © 2023 Page 75 of 121
 statusCode No This field Integer Y
describes the
Status Code of
a performed
Action. Eg-
success (0),
failed
(1),failed(-1)
for token
authorization
failed

statusDesc No Description of String N

the status of
the
performed
action

data No Description of object Y

the service

Sample API Payload

Request Payload :

"mobileNumber": "8617295228",

"channel":"WEB"

Success Response Payload:

"statusCode": 0,

"status": "SUCCESS",

"statusDesc": "Card status fetched successfully",

Card Management System (CMS) Issuer Interface guide

Integration Document confidential
iServeU pvt ltd © 2023 Page 76 of 121
 "data": [

"cardDetails": [

"card": [

"cardType": "GIFT",

"status": "SUCCESS",

"statusCode": 0,

"statusDesc": "Otp verification successful"

],

"accessStatus": [

],

"kycStatus": [

Failed Response Payload:

{
"statusCode": 1,
"status": "FAILED",
"statusDesc": "User not found",

Card Management System (CMS) Issuer Interface guide

Integration Document confidential
iServeU pvt ltd © 2023 Page 77 of 121
 "data": {}
}
6.3.15 Upgrade customerAPI
This API will be used to upgrade a customer.

End Point: user/upgrade_customer

Request/Response Fields

Parameter Name Sub Description Data Mi Ma Mandat Remarks

Tag Type n x ory

Request Payload

mobileNumber No mobile number String 10 10 Y Mandatory

must be 10 digit for all
unique
scenario

cardType NO Card type, 'GIFT', String Y mandatory

'GPR', 'SINGLE',
'MULTI',
'CREDIT',”CLC”

data Yes Fields that need Object N only

to be mandatory
updated/upgrad for GPR,
ed SINGLE,
MULTI or
CREDIT or
or CLC

kycType NO PAN, String 1 50 N Mandatory

AADHAR for GPR or
CREDIT
DL, CARD or
NAREGA CLC

Card Management System (CMS) Issuer Interface guide

Integration Document confidential
iServeU pvt ltd © 2023 Page 78 of 121
kycNumber NO Document String 1 50 N Mandatory
Number for GPR or
CREDIT
CARD or
CLC

aadhaarLink No Aadhaar String 1 500 N Mandatory

for single/
multi
currency
card

panLink No A link or String 1 500 N Mandatory

reference to for single/
the Permanent multi
Account currency
Number (PAN) card
document

airlineTicketLink No Airline Ticket String 1 500 N Mandatory

for single/
multi
currency
card

visaLink No Visa String 1 500 N Mandatory

for single/
multi
currency
card

passportLink No Passport String 1 500 N Mandatory

for single/
multi
currency
card

Card Management System (CMS) Issuer Interface guide

Integration Document confidential
iServeU pvt ltd © 2023 Page 79 of 121
dateOfBirth NO date of birth String 1 10 N Mandatory
format should be for
(YYYY-MM-DD) CREDIT
CARD or
GPR
CARD
or CLC

gender No Gender can be in String 1 10 N Mandatory

Male Female or for
Other CREDIT
CARD or
GPR card
or CLC

employment No 1.Salaried String N Mandatory

for credit
2.Self-employed
card
3.Business
Owner

4.Unemployed

product No Product String 1 50 N Mandatory

for credit
card

losProduct No Los Product String 1 50 N Mandatory

for credit
card

address No shipping address String 1 255 N Mandatory

for CREDIT
CARD or
CLC or GPR

Card Management System (CMS) Issuer Interface guide

Integration Document confidential
iServeU pvt ltd © 2023 Page 80 of 121
address1 No shipping address String 1 255 N Mandatory
1 for CREDIT
CARD or
CLC or GPR

city No shipping city String 1 50 N Mandatory

for CREDIT
CARD or
CLC or GPR

pincode No shippingPincode String 6 6 N 6 digits Valid

pin code

Mandatory
for CREDIT
CARD or CLC
or GPR

country No shippingCountry String 1 50 N Mandatory

for CREDIT
CARD or
CLC or GPR

state No shippingState String 1 50 N

channel No WEB/ANDRO String 1 10 Y

ID

Response Payload

status No Status of the String Y

performed
action. E.g. –
SUCCESS or
FAILED

Card Management System (CMS) Issuer Interface guide

Integration Document confidential
iServeU pvt ltd © 2023 Page 81 of 121
 statusCode No This field Intege Y
describes the r
Status Code of
a performed
Action. Eg-
success (0),
failed
(1),failed(-1)
for token
authorization
failed

statusDesc No Description of String N

the status of
the performed
action

data No Description of object Y

the Other
service

Sample API Payload

Request Payload for GPR:

"mobileNumber": "8249652456",

“cardType”:”GPR”,

"channel":"WEB",

"data": {

“kycType”: “aadhaar”

“kycNumber”: “123456789125”
"address": "bbsr",
Card Management System (CMS) Issuer Interface guide
Integration Document confidential
iServeU pvt ltd © 2023 Page 82 of 121
 "address1": "bbsr",
"city": "bbsr",
"country": "india",
"pincode": "752030",
"state": "odisha"
"dateOfBirth": "1999-10-12",

“gender”: “male”,

Request Payload for Single/ Multi currency card:

"mobileNumber": "8249652456",

“cardType”:”SINGLE”

"channel":"WEB",

"data": {

“aadhaarLink”: “”,

“panLink”: “”,

“airlineTicketLink”: “”,

“visaLink”: “”,

“passportLink”: “”

Request Payload for Credit card:

"mobileNumber": "8249652456",

“cardType”:”CREDIT”

Card Management System (CMS) Issuer Interface guide

Integration Document confidential
iServeU pvt ltd © 2023 Page 83 of 121
 "channel":"WEB",

"data": {

“kycType”: “aadhaar”

“kycNumber”: “123456789125”
"address": "bbsr",
"address1": "bbsr",
"city": "bbsr",
"country": "india",
"pincode": "752030",
"state": "odisha"
"dateOfBirth": "1999-10-12",

“employment”: “salaried”,

“gender”: “male”,

“product”: “”,

“losProduct”: “”,

Success Response Payload:

{
"statusCode": 0,
"status": "SUCCESS",
"statusDesc": "User upgrade successfully",
"data": {}
}

Failed Response Payload:

{
"statusCode": 1,
"status": "FAILED",
"statusDesc": "Failed to upgrade user",
"data": {}
}

Card Management System (CMS) Issuer Interface guide

Integration Document confidential
iServeU pvt ltd © 2023 Page 84 of 121
 6.4 Card Product
6.4.1 Add Product API
This API will be used for adding Product by Program Manager.
End Point: /product/add_product

Request/Response Fields

Parameter Name Sub Tag Description Data Type Min Max Mandatory Remark
Request Payload
productName No Name of the Product String 10 50 Y Unique in
every new
request
productDescriptio No Description of String 0 255 N
n product
productCategory No Category of product String 4 25 Y Only given
(PREPAID, GIFT, value allow
SINGLE, which is
MULTI,CREDIT) present in
bracket
cardType No Card Type String 4 25 Y Only given
(MAGSTRIPE, value
CHIP, allowed
CONTACTLESS) which is
present in
bracket
bin No unique bin number String 6 8 Y Only 6 or 8
(should be 6 or 8 digits
digit) number
allowed
binRange No Bin Range String 3 3 Y
cardValidity No validity of card(in Integer 1 1 Y Should be
year within 1 to 5) an integer
within 1 to
5 and if
isSave is
false
isAtmAllowed No Card on ATM Boolean Y Should be
Transaction (True/ boolean
False) (true/false)
isPosAllowed No Card on POS Boolean Y Should be
Transaction (true / boolean
false) (true/false)
isEcomAllowed No Card on Boolean Y Should be
E-commerce boolean
(true/false)

Card Management System (CMS) Issuer Interface guide

Integration Document confidential
iServeU pvt ltd © 2023 Page 85 of 121
 Transaction (true /
false)
mccCode mccCode, MCC code list Array Y Should be
mccType an array of
objects.
mccCode Yes MCC code String Y
mccType Yes MCC type String N
mccApplicable No MCC applicable or Boolean Y Should be
not boolean
(true/false)
countryApplicable No Country applicable Boolean Y Should be
or not boolean
(true/false)
maximumCardper No Maximum no. of Integer 1 2 Y GIFT card
Customer Card per Customer value- min
1,max-50

GPR card
value- min
1,max 5
isSave No isSave Boolean Y Should be
true if it's
to "Save
and
Continue",
else false.
createdBy No Created By String 1 50 N
creatorRole No Role of creator String 1 50 N
creatorId No Creator Id String 1 50 N
feeCode feeId, Fee Code Array N Should be
feeAmount, an array of
feeType objects.
feeId Yes Fee Id Integer N
feeAmount Yes Fee Amount String N
feeType Yes Fee Type String N
velocityCode velocityId, Velocity Code Array N Should be
velocityLimit, an array of
velocityCount, objects.
velocityType
velocityId Yes Velocity Id Integer N
velocityLimit Yes Velocity Limit String N
velocityCount Yes Velocity Count String N
velocityType Yes Velocity Type String N
currencyCode currencyCode, Currency Code Array N Should be
priorityCode, an array of
currencyType objects.
currencyCode Yes Currency Code String N
priorityCode Yes Priority Code String N
currencyType Yes Currency Type String N

Card Management System (CMS) Issuer Interface guide

Integration Document confidential
iServeU pvt ltd © 2023 Page 86 of 121
domesticTransacti No Domestic Array N Array
onType Transaction Type containing
types of
domestic
transaction
s
jitDetails jitAllowed, Jit Details Object N
isClientAuth,
clientAuthUrl
jitAllowed Yes Jit Allowed Boolean N
isClientAuth Yes Client Boolean N
Authentication
check
clientAuthUrl Yes Client String 0 255 N URL for
Authentication URL client
authenticati
on, if
applicable
addonDetails addonAllowed, Add on Details Object N
replacementAd
don,
maximumRepl
acementCardP
erCustomer,
parallelAddon,
maximumParal
lelCardPerCust
omer
addonAllowed Yes Add on Allowed or Boolean N
not
replacementAddon Yes Replacement Add Boolean N
on
maximumReplace Yes Maximum String N Value
mentCardPerCusto Replacement Card should be
mer Per Customer number
parallelAddon Yes Parallel Add on Boolean N
maximumParallel Yes Maximum Parallel String N Value
CardPerCustomer Card Per Customer should be
number
rewardsDetails isRewardsApp Rewards Details Object N Details
licable, related to
rewardsType, rewards
notificationMe program
chanisim
isRewardsApplica Yes RewardsApplicable Boolean N
ble or not
rewardsType Yes Rewards Type Array N Types of
rewards
offered
notificationMecha Yes Notification Array N Mechanism
nisim Mechanisim s for
notification
s

Card Management System (CMS) Issuer Interface guide

Integration Document confidential
iServeU pvt ltd © 2023 Page 87 of 121
 remarks No Remarks String 0 255 N Additional
remarks or
comments
countryCode code, Country details Array N Should be
type an array of
objects.
code Yes Country code String N
type Yes Country type String N
coolingPeriod No Cooling Period String 6 6 N Cooling
period
duration, if
applicable
cardDesignLink No Card design url String 1 500 N
channel No Name of channel, String 1 10 Y Only given
Contains value allow
(web/Android) which is
present in
bracket
Response Payload
status No Status of the String Y
performed action.
E.g. – SUCCESS or
FAILED
statusCode No This field describes Integer Y
the Status Code of a
performed Action.
Eg- success (0),
failed (1),failed(-1)
for token
authorization failed
statusDesc No Description of the String N
status of the
performed action
data No Response of the object Y
CMS API

Sample API Payload

Request Payload:
{
"productName": "PROD000checamayeek",
"productDescription": "testing purpose creation",
"productCategory": "GIFT",
"cardType": "MAGSTRIPE",
"bin": "122987",
"cardValidity": 3,
"isAtmAllowed": true,
"isPosAllowed": true,
"isEcomAllowed": true,
"isMcpAllowed": true,
"isDccAllowed": true,

Card Management System (CMS) Issuer Interface guide

Integration Document confidential
iServeU pvt ltd © 2023 Page 88 of 121
 "mccCode": [
{
"mccCode": "888",
"mccType": "jjj"
},
{
"mccCode": "111",
"mccType": "jjj"
}
],
"feeCode": [
{
"feeId": "1",
"feeType": "hhh",
"feeAmount": "10"
},
{
"feeId": "2",
"feeType": "hhhh",
"feeAmount": "20"
}
],
"velocityCode": [
{
"velocityId": "1",
"velocityLimit": "1000",
"velocityCount": "5",
"velocityType": "hhh"
},
{
"velocityId": "2",
"velocityLimit": "1000",
"velocityCount": "10",
"velocityType": "jjj"
}
],
"currencyCode": [
{
"currencyCode": "356",
"priorityCode": "1",
"currencyType": "hhh"
},
{
"currencyCode": "840",
"priorityCode": "2",
"currencyType": "hhh"
}
],
"countryCode": [
{
Card Management System (CMS) Issuer Interface guide
Integration Document confidential
iServeU pvt ltd © 2023 Page 89 of 121
 "code": “840”,
"type": "india"
},
{
"code": “345”,
"type": "pakistan"
}
],
"mccApplicable": true,
"countryApplicable": true,
"cardDesignLink": "https://card.com",
"binRange": "145",
"domesticTrancationType": [
"BalanceInquiry",
"PinChange",
"MiniStatemeny"
],
"maximumCardperCustomer": 3,
"coolingPeroid": "4",
"jitDetails": {
"jitAllowed": true,
"isClientAuth": true,
"clientAuthUrl": ""
},
"addonDetails": {
"addonAllowed": true,
"replacementAddon": true,
"maximumReplacementCardperCustomer": "",
"parallelAddon": true,
"maximumParallelCardperCustomer": ""
},
"rewardsDetails": {
"isRewardsApplicable": true,
"rewardsType": [
"Insurance Card",
"Launge Access"
],
"notificationMechanisim": [
"whatsapp",
"email"
]
},
"isSave":false,
"createdBy": "PROG9978559774",
"channel":"WEB"
}

Card Management System (CMS) Issuer Interface guide

Integration Document confidential
iServeU pvt ltd © 2023 Page 90 of 121
 Success Response Payload:
{
"statusCode": 0,
"status": "SUCCESS",
"statusDesc": "product added successfully",
"data": {}
}

Failed Response Payload:

{
"statusCode": 1,
"status": "FAILED",
"statusDesc": "Product already exists",
"data": {}
}

6.4.2 Fetch Product API

This API will be used for fetching Product by Program Manager.

End Point: /product/fetch_data
Request/Response Fields

Parameter Name Sub Tag Description Data Type Min Max Mandatory Remarks
Request Payload
createdBy No createdBy String 1 50 Y
status No Status can be String Y Only given
"ALL", value allow
"APPROVED", which is
"INITIATED", present in
"PENDING", bracket
"FAILED"
role No Role can be String N Not
CHECKER Mandatory,
but if
provided it
can only be
CHECKER
channel No Name of channel, String 1 10 Y Only given
Contains value allow
(web/Android) which is
present in
bracket
Response Payload
status No Status of the String Y
performed action.
E.g. – SUCCESS or
FAILED

Card Management System (CMS) Issuer Interface guide

Integration Document confidential
iServeU pvt ltd © 2023 Page 91 of 121
statusCode No This field describes Integer Y
the Status Code of a
performed Action.
Eg- success (0),
failed (1),failed(-1)
for token
authorization failed
statusDesc No Description of the String N
status of the
performed action
data No Description of the object Y
CMS

Sample API Payload

Request Payload
{
"createdBy": "PROG9978559774",
"status": "ALL",
"channel": "WEB"
}

Success Response Payload:

{
"statusCode": 0,
"status": "SUCCESS",
"statusDesc": "Product fetched successfully",
"data": [
{
"productName": "TestDataNIGHTWED",
"productDescription": "",
"productCategory": "GIFT",
"cardType": "MAGSTRIPE",
"bin": "818052",
"cardValidity": 2,
"isAtmAllowed": false,
"isPosAllowed": false,
"isEcomAllowed": false,
"isMcpAllowed": false,
"isDccAllowed": false,
"channel": "WEB",
"status": "APPROVED",
"remarks": "",
"mccCode": [
{
"mccCode": "763",
"mccType": "Agricultural Co-operatives"
},
{

Card Management System (CMS) Issuer Interface guide

Integration Document confidential
iServeU pvt ltd © 2023 Page 92 of 121
 "mccCode": "780",
"mccType": "Horticultural Services"
},
{
"mccCode": "1520",
"mccType": "General Contractors-Residential and Commercial"
},
{
"mccCode": "1711",
"mccType":"Air Conditioning Contractors Sales and Installation"
}
],
"feeCode": [],
"velocityCode": [
{
"velocityId": 676,
"velocityLimit": 10000,
"velocityCount": 10,
"velocityType": "atm_weekly_limit"
}
],
"currencyCode": [],
"countryCode": [
{
"code": "036",
"type": "Australia"
},
{
"code": "040",
"type": "Austria"
},
{
"code": "031",
"type": "Azerbaija"
},
{
"code": "044",
"type": "Bahamas"
},
{
"code": "050",
"type": "Bangladesh"
},
{
"code": "070",
"type": "Bosnia and Herzegovina"
},
{
"code": "108",
"type": "Burundi"
Card Management System (CMS) Issuer Interface guide
Integration Document confidential
iServeU pvt ltd © 2023 Page 93 of 121
 },
{
"code": "116",
"type": "Cambodia"
},
{
"code": "208",
"type": "Denmark"
}
],
"mccApplicable": true,
"cardDesignLink": "NA",
"binRange": 152,
"domesticTrancationType": [],
"maximumCardperCustomer": "10",
"jitDetails": {
"jitAllowed": true,
"isClientAuth": false,
"clientAuthUrl": ""
},
"addonDetails": {
"addonAllowed": true,
"replacementAddon": false,
"maximumReplacementCardperCustomer": null,
"parallelAddon": true,
"maximumParallelCardperCustomer": 10
},
"rewardsDetails": {
"isRewardsApplicable": true,
"rewardsType": [
"Launge access",
"Student reimbursements",
"Voucher"
],
"notificationMechanisim": [
"email",
"whatsapp",
"ISim"
]
}
}
]
}

Card Management System (CMS) Issuer Interface guide

Integration Document confidential
iServeU pvt ltd © 2023 Page 94 of 121
 Failed Response Payload
{
"statusCode": 1,
"status": "FAILED",
"statusDesc": "Failed to fetch Product",
"data": {}
}

6.4.3 Approve Product API

This API will be used for Approving products.
- Only privileged users can approve the product.
End Point: /product/approve_product

Request/Response Field

Parameter Name Sub Tag Description Data Type Min Max Mandatory Remarks
Request Payload
productName No name of product String 10 50 Y Product
name
which is
initiated
before
approverName No Approval name String 1 50 Y
isApproved No It confirms the Boolean Y
approval of
product
remarks No Remarks String N To
describe
why
product is
being
rejected
channel No Name of String 1 10 Y Only
channel, given
Contains value
(web/Android) allowed
which is
present in
bracket
Response Payload
status No Status of the String Y
performed
action. E.g. –
SUCCESS or
FAILED
statusCode No This field Integer Y
describes the
Status Code of a
performed
Action. Eg-

Card Management System (CMS) Issuer Interface guide

Integration Document confidential
iServeU pvt ltd © 2023 Page 95 of 121
 success (0),
failed
(1),failed(-1) for
token
authorization
failed
statusDesc No Description of String N
the status of the
performed
action
data No Description of object Y
the CMS

Sample API Payload

Request Payload:
{
"approverName": "ANKIT26",
"productName": "PROD000checkkkkkkkkk",
"isApproved": true,
"remarks": "approved",
"channel": "WEB"
}

Success Response Payload:

{
"statusCode": 0,
"status": "SUCCESS",
"statusDesc": "Card product approved successfully",
"data": {}
}

Failed Response Payload:

{
"statusCode": 1,
"status": "FAILED",
"statusDesc": "Failed to Approve Card details !! Try again after sometime..",
"data": {}
}

6.5 Card Functionality

6.5.1 Generate OTP API
This API will be used to generate OTP for authentication of customers or cards. for below scenario
- For View card details by customer
- For View CVV of customer

Card Management System (CMS) Issuer Interface guide

Integration Document confidential
iServeU pvt ltd © 2023 Page 96 of 121
 End Point: card/generate_otp
Request/Response Field

Parameter Name Sub Tag Description Data Type Min Max Mandatory Remarks
Request Payload
type No OTP requester String Y
type
(CUSTOMER /
CARD)
userName No User name String 1 50 Y Mandato
ry
cardRefNo No Card reference String 10 12 Y
Number
params No Same value String Y
need to pass at
time of
verification
OTP
expiryTime No OTP expiry String Y Mandato
time ry
channel No Name of String 1 10 Y Only
channel, given
Contains value
(web/Android) allow
which is
present in
bracket
Response Payload
status No Status of the String Y
performed
action. E.g. –
SUCCESS or
FAILED
statusCode No This field Integer Y
describes the
Status Code of a
performed
Action. Eg-
success (0),
failed
(1),failed(-1) for
token
authorization
failed
statusDesc No Description of String N
the status of the
performed
action
data No Description of object Y
the CMS

Card Management System (CMS) Issuer Interface guide

Integration Document confidential
iServeU pvt ltd © 2023 Page 97 of 121
 Sample API Payload
Request Payload:
{
"type": "CARD",
"userName": "CORP000000007",
"cardRefNo": "11872080012",
"params": "CARD_OTP",
"expiryTime": "5",
"channel": "WEB"
}

Success Response Payload:

{
"statusCode": 0,
"status": "SUCCESS",
"statusDesc": "OTP Generated Successfully",
"data": {}
}

Failed Response Payload:

{
"statusCode": 1,
"status": "FAILED",
"statusDesc": "Failed to Generate OTP !! Try again after sometime..",
"data": {}
}

6.5.2 View Card Details API

This API will be used to fetch all card details which are linked to the customer.
End Point: card/view_card_details
Request/Response Field

Parameter Name Sub Tag Description Data Type Min Max Mandatory Remarks
Request Payload
otp No String 4 6 Y
userName No User name String 1 50 Y Mandato
ry
params No String Y
channel No Name of String 1 10 Y Only
channel, given
Contains value
(web/Android) allow
which is
present in
bracket
Response Payload

Card Management System (CMS) Issuer Interface guide

Integration Document confidential
iServeU pvt ltd © 2023 Page 98 of 121
 status No Status of the String Y
performed
action. E.g. –
SUCCESS or
FAILED
statusCode No This field Integer Y
describes the
Status Code of a
performed
Action. Eg-
success (0),
failed
(1),failed(-1) for
token
authorization
failed
statusDesc No Description of String N
the status of the
performed
action
data No Description of object Y
the CMS

Sample API Payload

Request Payload:
{
"userName": "181",
"params":"aerteyrutyiuo646464",
"otp":"1234",
"channel":"WEB"
}

Success Response Payload:

{
"statusCode": 0,
"status": "SUCCESS",
"statusDesc": "Card Details Fetched Successfully",
"data": {
"status": "0",
"statusDesc": "Card Details Fetched successfully !!",
"viewCardResponseList": [

{
"cardRefNumber": 2111000071,
"productName": "PROD185998",
"isActive": false,
"expiryDate": "2705",
"isBlock": false,
"isHotList": false,
"lastFourDigit": 3282,
"cardType": "MAGSTRIPE",
"encryptedCard":
"TTRuamNJSnJja3Vo|TOjmqC0JE/lTzUSGM5TtLCI0|2yKtm9wvSYnq0U02NsJKxw==",
"nameOnCard": null,

Card Management System (CMS) Issuer Interface guide

Integration Document confidential
iServeU pvt ltd © 2023 Page 99 of 121
 "isVirtual": false,
"isPinSet": false,
"productType": "GIFT",
"createdDate": "2024-05-30T12:23:49.336126",
"updatedDate": "2024-05-30T12:23:49.336131",
"mobileNumber": 9348769107,
"preferredLanguage": "ENGLISH"
}
]
}

Failed Response Payload:

{
"statusCode": 1,
"status": "FAILED",
"statusDesc": "Unable to Fetch Card Details !! Try again after sometime..",
"data": {}
}

6.5.3 View Card CVV API

This API will be used to fetch the encrypted cvv details of the requested card.
End Point:card/ view_card_cvv
Request/Response Field

Parameter Name Sub Tag Description Data Type Min Max Mandatory Remarks
Request Payload
otp No String 4 6 Y
cardRefNo No Card reference String 10 12 Y
number
params No String Y
channel No Name of String 1 10 Y Only
channel, given
Contains value
(web/Android) allow
which is
present in
bracket
Response Payload
status No Status of the String Y
performed
action. E.g. –
SUCCESS or
FAILED
statusCode No This field Integer Y
describes the
Status Code of a
performed
Action. Eg-
success (0),
failed
(1),failed(-1) for

Card Management System (CMS) Issuer Interface guide

Integration Document confidential
iServeU pvt ltd © 2023 Page 100 of 121
 token
authorization
failed
statusDesc No Description of String N
the status of the
performed
action
data No Description of object Y
the CMS

Sample API Payload

Request Payload:
{
"cardRefNo": "12872080055",
"params": "aerteyrutyiuo646464",
"otp": "1234",
"channel": "WEB"
}

Success Response Payload:

{
"statusCode": 0,
"status": "SUCCESS",
"statusDesc": "CVV Fetched Successfully",
"data": {
"status": "0",
"statusDesc": "cvv successfully fetched",
"encryptedCvv": "QOGNZhCwWezRty9R/uwWUw=="
}
}

Failed Response Payload:

{
"statusCode": 1,
"status": "FAILED",
"statusDesc": "Unable to Fetch CVV !! Try again after sometime..",
"data": {}
}

6.5.4 View Card Balance API

This API will be used to fetch the balance of the requested card.
End Point: card/view_card_balance
Request/Response Field

Parameter Name Sub Tag Description Data Type Min Max Mandatory Remarks
Request Payload
cardRefNo No Card reference String 10 12 Y
number

Card Management System (CMS) Issuer Interface guide

Integration Document confidential
iServeU pvt ltd © 2023 Page 101 of 121
 channel No Name of String 1 10 Y Only
channel, given
Contains value
(web/Android) allow
which is
present in
bracket
Response Payload
status No Status of the String Y
performed
action. E.g. –
SUCCESS or
FAILED
statusCode No This field Integer Y
describes the
Status Code of a
performed
Action. Eg-
success (0),
failed
(1),failed(-1) for
token
authorization
failed
statusDesc No Description of String N
the status of the
performed
action
data No Description of object Y
the CMS

Sample API Payload

Request Payload:
{

"cardRefNo": "12872080055",

"channel": "WEB"

Success Response Payload:

{

"statusCode": 0,

"status": "SUCCESS",

"statusDesc": "Balance Fetched Successfully",

Card Management System (CMS) Issuer Interface guide

Integration Document confidential
iServeU pvt ltd © 2023 Page 102 of 121
 "data": {

"status": "0",

"statusDesc": "Balance available",

"balance": 0

Failed Response Payload:

{
"statusCode": 1,
"status": "FAILED",
"statusDesc": "Unable to Fetch Balance !! Try again after sometime..",
"data": {}
}

6.5.5 Resend OTP API (ONLY FOR SELF SIGN UP)

This API will be used to resend otp.
End Point: card/resend_otp
Request/Response Field

Parameter Name Sub Tag Description Data Type Min Max Mandatory Remarks
Request Payload
mobileNumber No CustomerMobil String 10 10 Y Mandato
e Number ry for all
scenario
cardType No card type should String Y
be either
PREPAID or
GIFT
channel No Name of String 1 10 Y Only
channel, given
Contains value
(web/Android) allow
which is
present in
bracket
Response Payload
status No Status of the String Y
performed
action. E.g. –
SUCCESS or
FAILED

Card Management System (CMS) Issuer Interface guide

Integration Document confidential
iServeU pvt ltd © 2023 Page 103 of 121
statusCode No This field Integer Y
describes the
Status Code of a
performed
Action. Eg-
success (0),
failed
(1),failed(-1) for
token
authorization
failed
statusDesc No Description of String N
the status of the
performed
action
data No Description of object Y
the FINO

Sample API Payload

Request Payload:

{
"mobileNumber": "6370098659",
"channel": "WEB",
"cardType": "GIFT"
}

Success Response Payload:

{
"statusCode": 0,
"status": "SUCCESS",
"statusDesc": "otp generation successfull",
"data": {
"ResponseCode": 0,
"MessageString": "OTP Generation Successful",
"ClientInitiatorId": "",
"RequestID": "1232618744258240512_0424202414365186",
"ClientRefID": "1232618744258240512",
"ResponseData": {
"ResponseCode": 0,
"MessageString": "OTP Generation Successful",
"ClientUniqueID": "1232618744258240512",
"ClientInitiatorId": "",
"RequestID": "1232618744258240512_0424202414365186",
"ResponseData": {
"ReferenceID": "826377",
"RFU1": "",
"RFU2": "",
"RFU3": ""
}
}
}
}

Card Management System (CMS) Issuer Interface guide

Integration Document confidential
iServeU pvt ltd © 2023 Page 104 of 121
 Failed Response Payload:
{
"statusCode": 1,
"status": "FAILED",
"statusDesc": "Unable to send OTP!! Try again after sometime..",
"data": {}
}

6.5.6 Generate Otp for Card API

This API will be used to generate Otp for Card. [same OTP generation cms api, authentication for
card generation]
End Point: card/otp_generation_for_card

Request/Response Field

Parameter Name Sub Tag Description Data Type Min Max Mandatory Remarks
Request Payload
cardType No card type String Y It has to be
should be either either GPR or
GPR or GIFT GIFT
userId No user id of the Numeric Y
User
params No Same value String N mandatory for
need to pass at GPR
time of
verification
OTP
expiryTime No OTP expiry Numeric 1 2 Y Range in 1 to
time 30

channel No Name of String 1 10 Y Only given

channel, value allow
Contains which is
(web/Android) present in
bracket
Response Payload
status No Status of the String Y
performed
action. E.g. –
SUCCESS or
FAILED
statusCode No This field Integer Y
describes the
Status Code of
a performed
Action. Eg-
success (0),

Card Management System (CMS) Issuer Interface guide

Integration Document confidential
iServeU pvt ltd © 2023 Page 105 of 121
 failed
(1),failed(-1)
for token
authorization
failed
statusDesc No Description of String N
the status of the
performed
action
data No Description of object Y
the FINO

Sample API Payload

Request Payload:
{
"cardType": "GPR",
"userId": "4444450000000201",
"channel": "WEB",
"params": "Params",
"expiryTime": "23"
}

Success Response Payload:

{
"statusCode": 0,
"status": "SUCCESS",
"statusDesc": "OTP Generated Successfully",
"data": {
"status": "0",
"statusDesc": "Otp Successfully send to *******146"
}
}
Failed Response Payload:
{
"statusCode": 1,
"status": "FAILED",
"statusDesc": "OTP generation failed",
"data": specific error
}

6.5.7 View Requested Card API

This API will be used to view requested cards for customers.
End Point: card/view_requested_card
Request/Response Field

Card Management System (CMS) Issuer Interface guide

Integration Document confidential
iServeU pvt ltd © 2023 Page 106 of 121
Parameter Name Sub Tag Description Data Type Min Max Mandatory Remarks
Request Payload
type No type can be String Y
ADMIN/CUST
OMER
userName No User name String 1 50 Y Mandato
ry
status No Status can be String Y
APPROVED,
PENDING OR
REJECTED
channel No Name of String 1 10 Y Only
channel, given
Contains value
(web/Android) allow
which is
present in
bracket
Response Payload
status No Status of the String Y
performed
action. E.g. –
SUCCESS or
FAILED
statusCode No This field Integer Y
describes the
Status Code of a
performed
Action. Eg-
success (0),
failed
(1),failed(-1) for
token
authorization
failed
statusDesc No Description of String N
the status of the
performed
action
data No Description of object Y
the FINO

Sample API Payload

Request Payload:
{
"type": "ADMIN",
"userName": "CORP8763112029",
"status": "PENDING",
"channel": "WEB"
}

Card Management System (CMS) Issuer Interface guide

Integration Document confidential
iServeU pvt ltd © 2023 Page 107 of 121
 Success Response Payload:
{
"statusCode": 0,
"status": "SUCCESS",
"statusDesc": "Card details fetched successfully",
"data": {
"result": [
{
"userName": "CUST9348909448",
"userId": "4444450000000197",
"productName": "Demo Product",
"productId": "01",
"cardType": "GIFT",
"cardNature": "false",
"status": "INITIATED",
"statusDesc": "Card requested succussfully",
"subStatus": 0,
"amount": "10.00",
"requestedDate": "2024-04-30T11:29:54.000Z",
"updatedDate": "2024-04-30T11:29:54.000Z",
"requesteeName": "CORP8763112029",
"requesteeRole": "ROLE_DISTRIBUTOR",
"requesteeId": "4444448763112029",
"cardRefNo": "2111000116"
}
]
}
}

Failed Response Payload:

{
"statusCode": 1,
"status": "FAILED",
"statusDesc": "No data present in database",
"data": {}
}

6.5.8 Otp Verification for Card API

This API will be used to verify otp for cards.
End Point: card/otp_verification_for_card
Request/Response Field

Parameter Name Sub Tag Description Data Type Min Max Mandatory Remarks
Request Payload

Card Management System (CMS) Issuer Interface guide

Integration Document confidential
iServeU pvt ltd © 2023 Page 108 of 121
 userName No User name String 1 50 Y Mandato
ry
cardRefNo No Card reference Numeric 10 12 Y
number
params No params String N Mandato
ry for
GPR
otp No otp Numeric 4 6 Y
referenceId No referenceId Numeric N
channel No Name of String 1 10 Y Only
channel, given
Contains value
(web/Android) allow
which is
present in
bracket
Response Payload
status No Status of the String Y
performed
action. E.g. –
SUCCESS or
FAILED
statusCode No This field Integer Y
describes the
Status Code of a
performed
Action. Eg-
success (0),
failed
(1),failed(-1) for
token
authorization
failed
statusDesc No Description of String N
the status of the
performed
action
data No Description of object Y
the FINO

Sample API Payload

Request Payload:
{
"userName": "CUST8368104146",
"cardRefNo": "2111000120",
"params": "gprcardtest",
"otp": "8998",
"referenceId": "",
"channel": "WEB",

Card Management System (CMS) Issuer Interface guide

Integration Document confidential
iServeU pvt ltd © 2023 Page 109 of 121
 Success Response Payload:
{
"statusCode": 0,
"status": "SUCCESS",
"statusDesc": "OTP Validated Successfully",
"data": {
"status": "0",
"statusDesc": "Card mapped to customer !!"
}
}

Failed Response Payload:

{
"statusCode": 1,
"status": "FAILED",
"statusDesc": "card Type not found For The card reference number",
"data": {}
}

6.5.9 Transaction Posting

This API will be used for transaction posting.
End Point: card/transaction_posting
Request/Response Field

Parameter Name Sub Tag Description Data Type Min Max Mandatory Remarks
Request Payload
deviceDetails No deviceDetails String Y
syncTime No syncTime String Y
txnDatetime No transaction date String Y
and time
cardType No Card type String Y
should be PPC
debitType No Debit type String Y
should be in
'SALE',
'ECOM', 'ATM'
customerMobileN No mobile number String Y Mandato
o ry for all
scenario

Card Management System (CMS) Issuer Interface guide

Integration Document confidential
iServeU pvt ltd © 2023 Page 110 of 121
 cardRefNumber No card reference String 10 12 Y
number
txnAmount No transaction String Y
amount
txnType No transaction type String Y Specific
should be in to
'ATM', 'POS', mentione
'ECOM' d types-
ATM,PO
S,ECOM
terminalId No terminal id String Y
atmIndicator No atm indicator String Y
terminalDescriptio No terminal String Y
n description
transactionId No transaction id String Y
mcc No mcc String Y
networkId No network id String Y
acquirerId No acquired id String Y
location No location String Y
authCode No Name of String Y
channel,
Contains
(web/Android)
remarks No remarks String Y
Response Payload
status No Status of the String Y
performed
action. E.g. –
SUCCESS or
FAILED
statusCode No This field Integer Y
describes the
Status Code of a
performed
Action. Eg-
success (0),
failed
(1),failed(-1) for
token
authorization
failed
statusDesc No Description of String N
the status of the
performed
action
data No Description of object Y
the FINO

Sample API Payload

Request Payload:

Card Management System (CMS) Issuer Interface guide

Integration Document confidential
iServeU pvt ltd © 2023 Page 111 of 121
{
"deviceDetails": "353765100019059|CAM4|device_to_server|",
"syncTime": "2020-04-13 16:47:13",
"txnDatetime": "2020-04-13 16:47:08",
"cardType": "PPC",
"debitType": "sw_m_spend",
"customerMobileNo": "8018394576",
"cardRefNumber": "4628987115",
"txnAmount": "10.0",
"txnType": "POS",
"terminalId": "POS-1234",
"atmIndicator": "20082020",
"terminalDescription": "Rahul Savarkar Pune, India",
"transactionId": "02607641432",
"mcc": "112",
"networkId": "192",
"acquirerId": "ACLoad333",
"location": "Shivaji Nagar, Pune",
"authCode": "076916",
"remarks": ""
}

Response Payload:
{
"statusCode": 0,
"status": "SUCCESS",
"statusDesc": "transaction posting successfull",
"data": {
"status": "0",
"statusDesc": "Amount debited successfully and limit Updated"
}
}

Failed Response Payload:

{
"statusCode": 1,
"status": "FAILED",
"statusDesc": "Transaction posting failed",
"data": {}
}

6.5.10 View Card Data by card reference number API:

This API will be used to fetch all card details which are linked to the customer.
End Point: card/view_card_data_by_cardrefnumber
Request/Response Field

Card Management System (CMS) Issuer Interface guide

Integration Document confidential
iServeU pvt ltd © 2023 Page 112 of 121
Parameter Name Sub Tag Description Data Type Min Max Mandatory Remarks
Request Payload
cardRefNo No Card reference String 4 6 Y
no.
channel No Name of String 1 10 Y Only
channel, given
Contains value
(web/Android) allowed
which is
present in
bracket
Response Payload
status No Status of the String Y
performed
action. E.g. –
SUCCESS or
FAILED
statusCode No This field Integer Y
describes the
Status Code of a
performed
Action. Eg-
success (0),
failed
(1),failed(-1) for
token
authorization
failed
statusDesc No Description of String N
the status of the
performed
action
data No Description of object Y
the CMS

Sample API Payload

Request Payload:

“cardRefNo”: 12345678901,

"channel":"WEB"

Success Response Payload:

Card Management System (CMS) Issuer Interface guide

Integration Document confidential
iServeU pvt ltd © 2023 Page 113 of 121
 "statusCode": 0,

"status": "SUCCESS",

"statusDesc": "Card Details Fetched Successfully",

"data": {

"createdDate":"2024-05-30T12:23:49.336126",

"lastModified":"2024-05-30T12:23:49.336126",

"productName": "demoProduct",

"productId":"123",

"mobileNumber":"8765432198",

"isActive": true,

"expiryDate": "2503",

"isBlock": false,

"isHotlist": false,

"lastfourDigit": "1921",

"cardType": " MAGSTRIPE ",

"encryptedCard": "pjxsCo8vOuAL0HR+HcWfe3j37D/sfn5DNxvB7BijBEE=",

"nameOnCard": "Sushree Mohanty",

"isVirtual": false,

"isPinSet": false,

"productCategory": "GPR"
}

Failed Response Payload:

{
"statusCode": 1,
"status": "FAILED",
"statusDesc": "Failed to get card data",
"data": {}
}

Card Management System (CMS) Issuer Interface guide

Integration Document confidential
iServeU pvt ltd © 2023 Page 114 of 121
 6.5.11 View Product API:
This API will be used to fetch a product.
End Point: product/fetch_product_details
Request/Response Field

Parameter Name Sub Tag Description Data Type Min Max Mandatory Remarks
Request Payload
productName No Name of the String 4 6 Y Mandato
product ry
channel No Name of String 1 10 Y Mandator
channel, y with the
Contains value
(web/Android) which is
present in
bracket
Response Payload
status No Status of the String Y
performed
action. E.g. –
SUCCESS or
FAILED
statusCode No This field Integer Y
describes the
Status Code of a
performed
Action. Eg-
success (0),
failed
(1),failed(-1) for
token
authorization
failed
statusDesc No Description of String N
the status of the
performed
action
data No Description of object Y
the CMS

Sample API Payload

Request Payload:
{

Card Management System (CMS) Issuer Interface guide

Integration Document confidential
iServeU pvt ltd © 2023 Page 115 of 121
 "productName": "product",

"channel": "WEB"

Success Response Payload:

"statusCode": 0,

"status": "SUCCESS",

"statusDesc": "Product Fetched Successfully",

"data": {}

Failed Response Payload:

{
"statusCode": 1,
"status": "FAILED",
"statusDesc": "Product not found",
"data": {}
}

6.5.12 View Card data by mobile number API:

This API will be used to view card details through mobile numbers.

End Point: /card/view_card_data_by_mobileno

Request/Response Fields

Request Payload

Request Payload

mobileNumber Mobile number string 1 10 Y Manda

tory
for all

Card Management System (CMS) Issuer Interface guide

Integration Document confidential
iServeU pvt ltd © 2023 Page 116 of 121
 scenar
io

channel channel must be string 1 10 Y Manda

ANDROID or WEB tory
with
the
value
which
is
given
in the
bracke
t

Response Payload
status Status of the performed string Y
action. E.g. – SUCCESS
or FAILED

statusCode This field describes the integer Y

Status Code of a
performed Action. Eg-
success (0), failed
(1),failed(-1) for token
authorization failed

statusDesc Description of the status string N

of the performed action

data Response of the CMS Y

API

Sample request:

Request Payload:
{

"mobileNumber":"8018394576",

"channel":"WEB"

Success Response Payload:

"statusCode": 0,

Card Management System (CMS) Issuer Interface guide

Integration Document confidential
iServeU pvt ltd © 2023 Page 117 of 121
 "status": "SUCCESS",

"statusDesc": "Product Fetched Successfully",

"data": {}

Failed Response Payload:

"statusCode": 1,

"status": "FAILED",

"statusDesc": "Failed to get Card data",

"data": {}

6.6 Card Support

6.6.1 Request Card API
This API will be used for request cards for customers.
End Point: card/request_card
Request/Response Field

Parameter Name Sub Tag Description Data Type Min Max Mandatory Remarks
Request Payload
isPhysical No physical/virtual boolean Y
card
cardType No card type should String Y
be either
GIFT or GPR
prodName No Product name String 1 50 Y
prodId No Product Id Numeric Y

Card Management System (CMS) Issuer Interface guide

Integration Document confidential
iServeU pvt ltd © 2023 Page 118 of 121
 amount No Amount Numeric N only
given in
GIFT
case
channel No Name of String 1 10 Y Only
channel, given
Contains value
(web/Android) allow
which is
present in
bracket
Response Payload
status No Status of the String Y
performed
action. E.g. –
SUCCESS or
FAILED
statusCode No This field Integer Y
describes the
Status Code of a
performed
Action. Eg-
success (0),
failed
(1),failed(-1) for
token
authorization
failed
statusDesc No Description of String N
the status of the
performed
action
data No Description of object Y
the FINO

Sample API Payload

Request Payload:
{
"cardType": "GIFT",
"isPhysical": false,
"prodName": "Amucheckingggggg",
"prodId": "717",
"amount": 101,
"channel": "WEB"
}

Success Response Payload:

{
"statusCode": 0,
"status": "SUCCESS",
"statusDesc": "Card requested successfully",

Card Management System (CMS) Issuer Interface guide

Integration Document confidential
iServeU pvt ltd © 2023 Page 119 of 121
 "data": {}
}

Failed Response Payload:

{
"statusCode": 1,
"status": "FAILED",
"statusDesc": "Already a gift is in processing, can’t offer more gift, cards right now",
"data": {}
}

6.6.2 Approve Requested Card API

This API will be used to approve requested cards for customers.
End Point: card/approve_requested_card
Request/Response Field

Parameter Name Sub Tag Description Data Type Min Max Mandatory Remarks
Request Payload
status No Status can be String Y
APPROVED
REJECTED
channel No Name of String 1 10 Y Only
channel, given
Contains value
(web/Android) allow
which is
present in
bracket
Response Payload
status No Status of the String Y
performed
action. E.g. –
SUCCESS or
FAILED
statusCode No This field Integer Y
describes the
Status Code of a
performed
Action. Eg-
success (0),
failed
(1),failed(-1) for
token
authorization
failed
statusDesc No Description of String N
the status of the

Card Management System (CMS) Issuer Interface guide

Integration Document confidential
iServeU pvt ltd © 2023 Page 120 of 121
 performed
action
data No Description of object Y
the FINO

Sample API Payload

Request Payload:
{
"status": "APPROVED",
"channel": "WEB"
}

Success Response Payload:

{
"statusCode": 0,
"status": "SUCCESS",
"statusDesc": "Card approved successfully",
"data": {}
}
Failed Response Payload:
{
"statusCode": 1,
"status": "FAILED",
"statusDesc": "Card reference number already mapped to a card",
"data": {}
}

7. Rollout Plan
● Not Applicable

8. Test Plan
● Unit testing and load testing is performed by developers, while integration and system
testing will be conducted by QA.

9. Appendix
● Not Applicable

Card Management System (CMS) Issuer Interface guide

Integration Document confidential
iServeU pvt ltd © 2023 Page 121 of 121