CenterFirst

API Documentation

Powered By
Table of Contents:

General Instructions: ............................................................................................................................................... 2

HTTP Request Methods ........................................................................................................................................... 2
URLs……………………………………………………………………………………………………………………………………………………….2
Merchant and Terminal Onboarding: ...................................................................................................................... 2
Terminal Onboarding............................................................................................................................................... 6
Merchant Update .................................................................................................................................................... 7
Terminal Update ....................................................................................................................................................10
Terminal Activation ...............................................................................................................................................10
Close Merchant .....................................................................................................................................................11
Terminal Deactivation ...........................................................................................................................................11
Get Merchant Details ............................................................................................................................................12
Get Terminals ........................................................................................................................................................13
Get MCC………………………………………………………………………………………………………………………………………………14
GET Transaction Status API by Custom Fields and RRN, CRN_U ...........................................................................14
Get Device Models ................................................................................................................................................15
Get Channels & Transaction Sets ..........................................................................................................................16
Webhook Call-backs ..............................................................................................................................................17
Merchant CPID Call-back API............................................................................................................................17
Terminal Status Callback API ............................................................................................................................17
TRANSACTION Notification API ........................................................................................................................17
Request Body Object Definition ............................................................................................................................18
Merchant and Terminal onboarding ................................................................................................................18
Sales Information Object Definition .................................................................................................................19
Company Information Object Definition ..........................................................................................................19
Personal Information Object Definition ...........................................................................................................20
Risk Profile Name Object Definition .................................................................................................................21
Channels ...........................................................................................................................................................21
Discount Rate ...................................................................................................................................................22
Settlement Info ................................................................................................................................................22
Terminal Request Object Definition .................................................................................................................22
Other Documents URL Object Definition .........................................................................................................23

Information in this document is Confidential and Proprietary to CredoPay Page 1 of 24

©2023 - All Rights Reserved, CredoPay
General Instructions:
• Before implementing any given API's, please refer the object definition thoroughly.
• Start by Implementing the GET APIs.
• Use merchant and terminal onboard API to onboard a merchant and a terminal under the merchant.
• The “action” parameter in the merchant and terminal create payload to be used for defining the draft
and submit actions of an application.
• The merchant and terminal CPID will be shared in the merchant and terminal call-back once the applica-
tion is approved.
• Use the terminal activation API to activate the device.
• The merchant and terminal update can be done only if the merchant is in APPROVED, REFER BACK, NEW
and DRAFT status.
• Use the full merchant and terminal payload to update the merchant/terminal using the unique number
or CPID for the approved merchant/terminal.

HTTP Request Methods

GET Get Merchants Get Terminals
Get Device Models Get MCC
Get Channels & Transaction Sets GET Transaction Status API
POST Merchant Onboard Terminal Onboard
Terminal Activation Close Merchant
Terminal Deactivation
PUT Merchant Update Terminal Update
Terminal Device Change API

URLs
UAT https://ucpbsapi.credopay.info/mms
Production https://api.thecenterfirst.com/mms
Postman Collection

Merchant and Terminal Onboarding:

Use the below payload to onboard the merchant and terminal details into the system. Make sure that all the
GET APIs are implemented before starting this step. The success response will return the unique reference num-
ber for the merchant and terminal reference number for the terminal separately.
***All the given data are for a demonstration purpose***

URL /v1/onboarding/merchant
Method POST
Authorization API Key

Request {
"salesInformation": {
"merchantReferenceNumber": "UTTR62160T",
"region": "southregion",

"branchCode": "8754534293"

Information in this document is Confidential and Proprietary to CredoPay Page 2 of 24

©2023 - All Rights Reserved, CredoPay
 },
"companyInformation": {
"legalName": "Merchanttt API one",
"brandName": "API",
"address": "42,abirami nagar irumbuliyur tamabram chennai",
"pincode": "600032",
"latitude": "11.0249539",
"longitude": "81.207336",
"businessType": "INDIVIDUAL",
"establishedYear": "10-12-2020",
"mcc": "5411",
"emailDomain": [
"credopay.com",
"gmail.com",
]
},
"channel": [
{
"name": "POS",
"transactionSets": [
"Auth/Pre-Auth",
"Refund",
"Void",
"Sales",
"Cash@POS"
]
},
{
"name": "MATM",
"transactionSets": [
"Withdrawal",
"Balance Enquiry"
]
},
{
"name": "AEPS",
"transactionSets": [
"Mini Statement",
"Withdrawal",
"Balance Enquiry",
"Sales"
]
}
],
"personalInfo": [

{
"pan": {
"documentNumber": "YIUOP0470G",
"url": [

Information in this document is Confidential and Proprietary to CredoPay Page 3 of 24

©2023 - All Rights Reserved, CredoPay
 "https://ucpbs.credopay.info/mer-
chants/kyc/view/649180508b821da294a6a8ce/testaadharjpg_1687257443262.jpg?m
ime=image/jpeg"
]
},

"xmlAadhar": {
"documentNumber": "5175XXXXXX13",
"url": [

"https://ucpbs.credopay.info/mer-
chants/kyc/view/xml/tej.xml?mime=text/xml"
]
},
// Plain Aadhar//
"aadhar": {
"documentNumber": "763077839744",
"url": [
"https://ucpbs.credopay.info/mer-
chants/kyc/view/xml/tej.xml?mime=text/xml"
] "title": "Mr",
"dob": "04-10-1996",
"firstName": "AJAI",
"lastName": "TEST",
"address": "Vinoth Kumar K S/O: Kuber Singh NO 42 ABIRAMI NA-
GAR IRUMBULIYUR TAMBARAM WEST Tambaram Tambaram,Kan-
cheepuram Tamil Nadu 600045",
"pincode": "600032",
"mobile": "8754534293",
"phone": "0449843323210",
"email": "[email protected]",
"nationality": "Indian"
}
],
"settlementInformation": [
{
"bankAccountNumber": "139301518840",
"ifsc": "ICIC0001393",
"accountType": "savings"
}
],
"riskProfileName": "new Plan",
"discountRate": [ (Note: Discount rate is Optional)
"posPlan",
"matmPlan",
"upiPlan",
"aepsPlan"
],
"otherDocuments": [
{
"name": "CANCELLED_CHEQUE",
"documentNumber": "139301518840",

Information in this document is Confidential and Proprietary to CredoPay Page 4 of 24

©2023 - All Rights Reserved, CredoPay
 "url": [
"https://ucpbs.credopay.info/mer-
chants/kyc/view/649180508b821da294a6a8ce/testaadharjpg_1687257443262.jpg?m
ime=image/jpeg"
]
}
],
"terminalInfo": [
{
"terminalName": "Terminals",
"address": "26B, 3rd Floor, Chennai",
"pincode": "600032",
"latitude": "13.0249539",
"longitude": "80.207336",
"channel": [

"AEPS",
"POS",
"MATM"

],
"deviceModel": "a75",
"deviceSerialNumber": "123T56k712wwder65",
"deviceImeiNumber": "87823921"

//**For UPI & Combinations//

"deviceType":"standee", (Can provide sticker/soundbox/standee)

"welcomeKitSerialNo":"STANDEE34407"
"upiVpa":"SET@CUB”.

}
],
"action": "SUBMIT"
}

Note:
1. Only Device type can also be provided
2. Device Type Standee, Sticker or soundbox can be provided with
welcomekit serial number
3. Only upiVpa also can be provided to activate

Information in this document is Confidential and Proprietary to CredoPay Page 5 of 24

©2023 - All Rights Reserved, CredoPay
 Response {
"status": 200,
"message": "Merchant created successfully",
"uniqueReferenceNumber": "UTTR62160T",
"terminal": [
{
"message": "Terminal created successfully",
"terminalName": "Terminals",
"terminalReferenceNumber": "UTTR62160TT001"
}
]
}

Terminal Onboarding
Use the merchant unique reference number or the CPID for onboarding a new/additional terminal under the mer-
chant.

URL /v1/onboarding/terminal

Method POST

Authorization API Key

Request
[{
"merchantCpid":"CPMS29010007126",
"channel": [

"POS",

"MATM",

"AEPS"
],

"deviceModel": "A75",
"deviceSerialNumber": "A992348025",
"deviceImeiNumber": "9811567891",
"terminalName":"pos",
"latitude": "13.0249539",
"longitude": "80.207336",
"pincode": "600032",
"address": "26B, 3rd Floor, Chennai, EKKATUTHAN-
GAL, Tamil Nadu, 600032",
"pin":"293012",
"action": "SUBMIT"
}]

Information in this document is Confidential and Proprietary to CredoPay Page 6 of 24

©2023 - All Rights Reserved, CredoPay
 //** For UPI & Combinations //

"deviceType":"sticker/standee/soundbox",
"welcomeKitSerialNo":"CFST0001212",
"upiVpa":"SET@CUB”.

Response [
{
"Status": 200,
"Message": "Terminal created successfully",
"Data": {
"terminalName": "pos",
"terminalReferenceNumber": " CPMS29010007126"
}
}
]

Merchant Update
Merchant data can be updated using the merchant unique reference number or the merchant CPID. The mer-
chant update can be done only if the merchant status is in New entry, Refer back, Approved or Draft.

URL /v1/onboarding/merchant-update/:ID

Method PUT

Authori- API Key

zation

Request {
"salesInformation": {
"region": " southregion"

},
"companyInformation": {
"legalName": "onboarding API update",
"brandName": "API",
"address": "42,abirami nagar irumbuliyur tamabram chennai",
"pincode": "600032",
"businessType": "INDIVIDUAL",
"establishedYear": "10-12-2020",
"mcc": "5411",
"emailDomain": [
"credopay.com",
"gmail.com"

]
},
"channel": [

Information in this document is Confidential and Proprietary to CredoPay Page 7 of 24

©2023 - All Rights Reserved, CredoPay
 {
"name": "POS",
"transactionSets": [
"Auth/Pre-Auth",
"Refund",
"Void",
"Sales",
"Cash@POS"
]
},
{
"name": "MATM",
"transactionSets": [
"Withdrawal",
"Balance Enquiry"
]
},
{
"name": "AEPS",
"transactionSets": [
"Mini Statement",
"Withdrawal",
"Balance Enquiry",
"Sales"
]
}
],

"personalInfo": [
{
"pan": {
"documentNumber": "ZZSOD0470G",
"url": [
"https://ucpbs.credopay.info/mer-
chants/kyc/view/649180508b821da294a6a8ce/testaadharjpg_1687257443262.jpg?mime=im-
age/jpeg"
]
},

"xmlAadhar": {
"documentNumber": "7630XXXXXX44",
"url": [
"https://ucpbs.credopay.info/mer-
chants/kyc/view/xml/tej.xml?mime=text/xml"
]
},
// Plain Aadhar//
"aadhar": {
"documentNumber": "763077839744",
"url": [
"https://ucpbs.credopay.info/mer-
chants/kyc/view/xml/tej.xml?mime=text/xml"

Information in this document is Confidential and Proprietary to CredoPay Page 8 of 24

©2023 - All Rights Reserved, CredoPay
 ]
},
"title": "Mr",
"dob": "04-10-1998",
"firstName": "ajai",
"lastName": "Kumar",
"address": "TEST",
"pincode": "600045",
"mobile": "8898887888",
"phone": "0449843323210",
"email": "[email protected]",
"nationality": "Indian"
}
],
"settlementInformation": [
{
"bankAccountNumber": "139301118840",
"ifsc": "ICIC0001393",
"accountType": "savings"
}
],
"riskProfileName": "new Plan",
"discountRate": [ (Discount Rate is Optional)
"posPlan",
"matmPlan",
"upiPlan",
"aepsPlan"
],
"otherDocuments": [
{
"name": "CANCELLED_CHEQUE",
"documentNumber": "9876143221",
"url": [
"https://ucpbs.credopay.info/mer-
chants/kyc/view/649180508b821da294a6a8ce/testaadharjpg_1687257443262.jpg?mime=im-
age/jpeg"
]
}
],
"action": "SUBMIT"
}

Response {
Status: 200,
Message: “Merchant Updated Successfully”,
}

Information in this document is Confidential and Proprietary to CredoPay Page 9 of 24

©2023 - All Rights Reserved, CredoPay
Terminal Update
Terminal data can be updated using the terminal reference number or the CPID. The terminal update can be
done only if the terminal status is in New entry, Refer back, Approved or Draft. If you want to change the device
serial number, use terminal deactivation API and terminal activation API to activate a new device serial number.

URL /v1/onboarding/terminal-update/ID
Method PUT
Authorization API Key
Request {
"channel": [
"POS”,
“MATM”,
“AEPS”
],

"terminalName":"vinoth updte",
"pincode": "600045",
"address": "26B, 3rd Floor, Chennai, EKKATUTHAN-
GAL, Tamil Nadu, 600032",
"action": "SUBMIT"
}
//** For UPI & Combinations //

"deviceType":"sticker/standee/soundbox",
"welcomeKitSerialNo":"CFST0001212",
"upiVpa":"SET@CUB”

Response {
Status: 200,
Message: “Terminal Updated Successfully”,
}

Terminal Activation
Terminal activation can be done using the terminal reference number or the CPID. The login and password will
be shared in the SMS (plain JSON) and terminal call-back (encrypted).

Note: The password is encrypted using the API key shared without the hyphens. Algorithm used AES CBC 256.
Base 64 decode -> decrypt using AES CBC 256

URL /v1/onboarding/terminal-activate/CPID
Method POST
Authorization API Key
Request {
"reason":"terminal activation"
}

Response
{
Status: 200,
Message: “Terminal Activated successfully”,
}

Information in this document is Confidential and Proprietary to CredoPay Page 10 of 24

©2023 - All Rights Reserved, CredoPay
Close Merchant
Merchant can be closed using the merchant unique reference number or the merchant CPID, the merchant will
be closed and all the terminals underneath the merchant will be deactivated. Merchant close can be done in any
application status.

URL /v1/onboarding/merchantDeactivate/CPID
Method POST
Authorization API Key
Request
{
"reason": "Merchant deactivation"
"type": "DEACTIVATE" / “CLOSE”

Response {
Status: 200,
Message: “Merchant closed successfully”,
}

Terminal Deactivation
Terminal deactivation can be done using the terminal reference number or the terminal CPID. The terminal/de-
vice will be deactivated, the terminal deactivation can be done in any application status.

URL /v1/onboarding/terminal-deactivate/CPID
Method POST
Authorization API Key
Request
{
"reason": "Terminal deactivation"
}

Response
{
Status: 200,
Message: “Terminal Deactivated successfully”,
}

Terminal Device Change API

For changing the device serial number under a terminal use this API.

Information in this document is Confidential and Proprietary to CredoPay Page 11 of 24

©2023 - All Rights Reserved, CredoPay
 URL /v1/onboarding/terminal-device-update/CPID
Method POST
Authorization API Key
Request {
"deviceModel":"VM30",
"newDeviceSerialNumber":"BB332423440",
"activeDeviceSerialNumber":"BB332423432",
"deviceImeiNumber":"353453452131232143"

Response
{
"status": "success"
}

Get Merchant Details

Upon onboarding a merchant, this can be used to know the merchant status. You can use the merchant unique
reference number or the merchant CPID to know the status.

URL /v1/onboarding/merchant-detail/CPID

Method GET

Authorization API Key

Request
Response {
"data": {
"salesInformation": {
"mechantReferenceNumber": "UI-UI-6453745387",
"region": "all region"
},
"companyInformation": {
"legalName": "Federal Fri 2",
"brandName": "Federal Fri 2",
"address": "300",
"pincode": "600032",
"businessType": "Individual",
"gstin": "",
"mcc": "5411",
"channel": [
{
"name": "UPI",
"transactionSets": [
"Sales"
]
}
]

Information in this document is Confidential and Proprietary to CredoPay Page 12 of 24

©2023 - All Rights Reserved, CredoPay
 },
"personalInfo": [
{
"title": "Mr.",
"dob": "2005-12-07T18:30:00.000Z",
"firstName": "Vikas",
"lastName": "test",
"address": "Rank One",
"pincode": "600032",
"mobile": "6000000000",
"email": "",
"nationality": "Indian",
"pan": "EUIRY8923A",
"aadharNumber": "",
"passportNumber": "",
"passExpiryDate": ""
}
],
"settlementInformation": [
{
"bankAccountNumber": "6754646354634347",
"ifsc": "UBIN0409403"
}
]
},
"status": {
"status": "activated",
"EkycComment": [],
"documentStatus": []
},
"aggregatorId": "CPPF29010000011",
"cpId": "CPMS29010007654"
}

Get Terminals
Upon onboarding a terminal, this can be used to know the status. You can use the terminal reference number or
the terminal CPID to get the status.

URL /v1/onboarding/terminal-detail/CPID

Method GET

Authorization API Key

Response {
"cpId": "CPST29010007319",
"applicationStatus": "approved",
"transactionStatus": "approved",
"keyExchange": false,

Information in this document is Confidential and Proprietary to CredoPay Page 13 of 24

©2023 - All Rights Reserved, CredoPay
 "deviceNumber": null,
"login_id": "Not yet activated"
}

Get MCC
URL /v1/onboarding/mcc?mccCode

Method GET

Params Key Value

mccCode 2882
Authorization API Key

Response

{
"data": [
{
"mccCode": "5411",
"natureOfBusiness": "grocery stores, supermarkets",
"mccClassification": "emerging"
}
]
}

GET Transaction Status API by Custom Fields and RRN, CRN_U

Method GET

Url v1/onboarding/transactions/status

Information in this document is Confidential and Proprietary to CredoPay Page 14 of 24

©2023 - All Rights Reserved, CredoPay
Parameters
Key Value

custom_field1 Custom Field 1

custom_field2 Custom Field 2

custom_field3 Custom Field 3

custom_field4 Custom Field 4

custom_field5 Custom Field 5

custom_field6 Custom Field 6

custom_field7 Custom Field 7

custom_field8 Custom Field 8

custom_field9 Custom Field 9

custom_field10 Custom Field 10

rrn rrn

crn_u crn_u

RequestHead-
Key Value
ers

Get Device Models

URL /v1/ onboarding/device-model

Method GET

Authorization API Key

Response
[
{
"deviceTtype": "mPOS",
"name": " VM30",
},
{
"deviceTtype": "POS",
"name": "A75",
},

Information in this document is Confidential and Proprietary to CredoPay Page 15 of 24

©2023 - All Rights Reserved, CredoPay
 {
"deviceTtype": "POS",
"name": "WPOS-3",
},
]

Get Channels & Transaction Sets

URL v1/onboarding/txn-sets

Method GET

Params Key Value

mccCode 2882
Authorization API Key

Response
"channel": [
{
"name": "POS",
"transac-tionSets": [
"sale",
"cash@pos",
"void"
]
},
{
"name": "MATM",
"transac-tionSets": [
"Cashwithdrawal",
"balanceEnquiry"
]
},
{
"name": "UPI",
"transactionSets": [
"sale"
]
}
],

Information in this document is Confidential and Proprietary to CredoPay Page 16 of 24

©2023 - All Rights Reserved, CredoPay
Webhook Call-backs
Merchant CPID Call-back API
After approval of any Merchant, the CPID will be shared using the webhook information shared by the
customer.

Method POST

Url Webhook to be configured in Credopay Admin Portal

Request Body {
"aggregator_id":"CPPF29010000001","CPID":"CPMS29010000001","merchant-
ReferenceNumber":"AGG2127721","status":{"status":"approved"," EkycCom-
ment":{"Pan":"Matched","Aadhar":"Matched","Bank":"Matched","Gst"
:"Matched"},"documentStatus":{"Pan":"EKYC Verified","Aadhar":"EKYC
Verified","Bank":"EKYC Verified","Gst":"EKYC failed"}},"type":"mer-
chant","remarks":"Merchant Approved Successfully"
}

Expected Re-
sponse code 200 Success

Terminal Status Callback API

The terminal must be in ACTIVE status to implement this API.

Method POST

Url Webhook to be configured in Credopay Admin Portal

Request Body {
aggregator_id: CPPF29010000001,CPID:
CPST29010000001,
status: 'activated',
terminalReferencen-
number:'AGG2127721T001',
type: 'terminal_status',
remarks: 'Terminal Activated Successfully',
password: 'UOBDRtbGiObBvcGd1TzV8A==',
login_id: '3000008001'
}

Expected Re- 200 Success

sponse code

TRANSACTION Notification API

Information in this document is Confidential and Proprietary to CredoPay Page 17 of 24

©2023 - All Rights Reserved, CredoPay
 Method POST

Url Webhook to be configured in Credopay Admin Portal

Request Body
{
"rrn": "31582000232",
"is_void": false,
"is_reversed": false,
"is_disputed": false,
"amount": 102,
"card_type": "contactless",
"card_payment_type":"debit",
"card_usage_type":"domestic"
"masked_pan": "476173XXXXXX0010",
"network": "visa",
"payment_method": "card",
"terminal_cpid": "CPST29010000001",
"custom_field1":"PTTM036240",
"custom_field2":"16417950037",
"crn_u":"PTTM036240",
"transaction_type": "purchase",
"merchant_cpid":"CPMS29010000001",
"created_at": "2020-06-08 13:00:00",
"status": "success"
"chargeSlipURL": "https://ucpbs.credopay.info/transac
tions/slip/647fa67c1erf723bw0232a8d"

Expected Response
code 200 Success

Request Body Object Definition

Merchant and Terminal onboarding

Key Condition Type Description

salesinformation M Array Merchant Sales Details

companyinformation M Array Merchant Company Details

personalinformation M Array Merchant Personal Details

settlementInformation M Array Merchant Payment Gateway Details

riskInfo M String Aggregator Risk Profile Name

otherdocuments M Array Merchant KYC Documents

Information in this document is Confidential and Proprietary to CredoPay Page 18 of 24

©2023 - All Rights Reserved, CredoPay
 terminalInfo M Array Terminal Information

action M String Merchant and Terminal application

submit/create

Sales Information Object Definition

Key Condition Type Description Values Max Length

10
applicationNumber M String Unique Reference
Number

region O String The merchant region North NA

East
West
South

Company Information Object Definition

Key Condition Type Description Values Max Length

n

legalName M String Company Legal 60

Name

brand_name M String Company Brand 60

Name

address M String Company Regis- 120

teredAddress

pincode M String Company Regis- 6

teredPincode

businessType M String Business Type individual-

Individuals

Information in this document is Confidential and Proprietary to CredoPay Page 19 of 24

©2023 - All Rights Reserved, CredoPay
 proprietorship-
Proprietorship

partnership-Part-
nership

private - Private
Limited Co

public- Public
Limited Co

trusty- Trusty

other- Other

established_year C Date Company Estab- 10

lished Year

registered_number C String Registered 20

Number

pan C Object Company PAN 10

gstin C Object Company GSTIN 15

mcc M String MCC ID MCC Get API 4

emailDomain M Array Email domain

of the mer-
chant

Personal Information Object Definition

Key Condition Type Description Values Max

Length
title O String Person Title Mr
Miss
Mrs
Dr
Prof
Sr
Jr
Captain
Rev

Information in this document is Confidential and Proprietary to CredoPay Page 20 of 24

©2023 - All Rights Reserved, CredoPay
 first_name M String Person First Name 60

last_name M String Person Last Name 60

address M String Address 180

pincode M String Pincode 6

mobile M String Mobile number 10

phone O String Telephone/Landline number 12

email M String Email Address 60

nationality M String Nationality 50

pan O Object PAN number 10

aadhar C Object Mandatory for AEPS Mer- 12

chant.
passport O String Passport Number 10

passport_ex- O Date Passport Expiry date 10

piry_date
dob M Date Date of Birth

Risk Profile Name Object Definition

Key Condition Type Description Values Max

Length

riskProfileName C String The risk

profile
created
for FRM

Channels
Key Condition Type Description Values Max Length

name M String Channels enabled GET API

for the aggregator

Information in this document is Confidential and Proprietary to CredoPay Page 21 of 24

©2023 - All Rights Reserved, CredoPay
 transactionSets M Array Transaction sets en- GET API
abled for the aggre-
gator

Discount Rate
Key Condition Type Description Values Max Length

discountRate C Array Name of the MDR

plan

Settlement Info
Key Condition Type Description Values Max Length

bankAccountNumber M String Bank account num- 20

ber of the merchant

ifsc M String IFSC number of the 11

merchant bank ac-
count

Terminal Request Object Definition

Key Condition Type Description Values Max Length

60
terminalName M String Name of the termi-
nal
address M String Terminal Address 120

pincode M String Terminal Pin code Pin code 6

device_model M String Terminal Device Device Models

Model ID Get API

channel M Array Channels al-

lowed for the
aggregator
20
deviceSerialNumber C String Device serial
number

15
deviceImeiNumber C String IMEI number of
the device

Information in this document is Confidential and Proprietary to CredoPay Page 22 of 24

©2023 - All Rights Reserved, CredoPay
 upi_terminal_type C String UPI Terminal Type ONLINE 7
OFFLINE

upi_offline_type C String UPI Offline Type STATIC, DY- 7

NAMIC,
BOTH

Other Documents URL Object Definition

Values Max
Key condition Type Description
Length

name M String Name of the

PAN_CARD
document
AADHAR
CANCELLED_CHEQUE
BUSINESS_ADDRESS_PROOF
PASSPORT
DRIVING_LICENSE
RATION
VOTER_ID
PHOTO
MERCHANT_AGREEMENT
GST
NO_GST
???
docu- M String Document Num-
ment ber
Num-
ber
url M Array Document URL PDF, JPEG, PNGJE 2MB

url M Array Aadhar XML, PDF, JPEG, PNGJE 2MB

Information in this document is Confidential and Proprietary to CredoPay Page 23 of 24

©2023 - All Rights Reserved, CredoPay