Toucan Developer

API Menu

Close API Menu

Get Started

The Toucan provides a sandbox environment which can be utilized to test your awesome creation before taking them Live. Toucan APIs are HTTP-based Restful API that use JWT token-based authentication. All APIs are stateless; both request and response are in JSON format.

While some Toucan features do not apply to the sandbox, such as issuing merchant statements etc, the sandbox has the same Toucan API feature set as the live environment. When a transaction is tested through a sandbox account, a mock transaction is created that behaves exactly like a transaction in the live environment and therefore using Toucan API calls, you can test and debug your apps without referencing any real or live Toucan data.

Sandbox

URL: https://sandbox.toucanus.com

You will need a JWT token (also referred as API Key) before any API can be successfully executed on Toucan Sandbox. Please use the provided Contact form on this website to request generation of test tokens. All generated tokens will have a six-month year expiry.

Toucan sandbox and live only supports https POST for all API methods, Message structure is detailed in below section, incoming message need to confirm to provide json specification of messages.

It is better practise to test any change in sandbox environment before feature is is made live in production environment.

Browse through the toucan API guide for request and response message structure, checkout FAQ section and still you have query or suggestions we would love to receive an email @ [email protected]

Run in Postman button

The quicker you can get users started, the better. One way to jumpstart the configuration of an API is by using Run in Postman buttons. This can reduce more lengthy and tedious explanations about parameters and other configurations for an API.

Authentication

You will receive a token (API keys) via email to authenticate requests. Each token is valid only for a specific time frame generally six months. In case you lose them or need a fresh token please use contact form to generate.

Provided keys are for sandbox environments and once testing is completed you can receive production keys before go-live.

Use provided token as part of https header using key as “X-API-Key” and value as provided token.

POST /api/user/inq HTTP/2

Host: sandbox.toucanus.net

Accept: application/json, text/plain, */*

Content-Type: application/json; charset=utf-8

X-API-Key: eyJhbGciOiJIUzI1NiJ9.eyJzdWIiOiJnYXV0YW1AdG91Y2FuIiwiaWF0IjoxNjI2MDk3NzcxLCJle
HAiOjE2MjYxMDQ5NzF9.xijHvprs07UqC_wPajAqaL1aRkB3TAUBBp67atP0AFQ

Content-Length: 83

Origin: https://sandbox.toucanus.net

DNT: 1

Connection: keep-alive

Referer: https://sandbox.toucanus.net/

TE: Trailers

Message Structure

Toucan used REST based HTTP POST message structure with http header and http data. HTTP Data include header and payload structure as described below

HTTP Request header

Authorization use X-API-Key tag for authentication

Content Type application/json

Request Method POST

HTTP Request Data Structure

{

"messageID":"",

"requestType":"",

"object":{

"id":"60ab2a1e99a7851065f3c795"

}

}

Contains message body with “object” tag which contain request payload

HTTP Response Data Structure

Additional to HTTP status, application responded with business status and error code as described below, for error code refer individual API documentation

{

"requestType":"QUERY",

"success":true,

"object":{

"id":"60ab2a1e99a7851065f3c795",

"merChainName":"Awesome Cards",

"merchantStatus":"ACTIVE",

}

}

Message Header contains a “success” tag which represents backend request status. 

 

Contains message response body with “object” tag which contain response data

Production Environment

For security reasons in production, your source IP will be whitelisted. All requests would follow https, TLS v1.2 specification.

Toucan team will provide production security token which can be used for integration, token key will need to be periodically renewed based on expiration cycle.

Application Submit Request

This API can be used to submit merchant application for further processing. The response will contain the status of the application processing. If “In Progress” response would have the current step at which application is being processed. If all the steps are thru, response would contain the status “Merchant Successfully boarded”.

API URL

api/application/submit

HTTP Method

POST

REQ/RES TYPE

Application/JSON

Field name Description Data type Mandatory Length

Message ID

Message ID for application submit request

String

 

 

Object

Object content

-

 

 

Application status

Specifies the application status “SUBMITTED”

Enum

 

 

ID

Specifies the request ID

String

Y

 

Request type

CREATE (Fixed value)

String

 

 

Application Submit Response
Field name Description Data type Mandatory Length

Message ID

Message ID for Toucan request

 

 

 

Request type

Request type “UPDATE”

Sting

 

 

Object

Request content

-

 

 

ID

Request ID

Sting

 

 

Application number

Specifies the application number

Sting

 

 

Application status

“IN-PROGRESS” (fixed value)

Sting

 

 

Current processing step

The status of the current processing application.

Enum

 

 

Submit date

Specifies the submitted date.

 

 

 

First name

Specifies the merchant’s first name.

Sting

Y

 

Last name

Specifies the merchant’s last name.

Sting

Y

 

Application Email ID

It stores the email Id of the applicant.

String

Y

 

Country code

Specifies the Country code of the merchant.

String

Y

 

Number

Specifies the merchant mobile number.

String

Y

 

Input Source

Represents the exact source, with which the Merchant is trying to connect.

Values: BANK_APP, BANK_INTERNAL_APP, BANK_WEB, DSA, MERCHANT_APP, SELF_PORTAL, SM.

Enum

 

 

Input Source ID

Specifies the ID

String

 

 

Info Method

Represents the approach method of merchants to Toucan application.

Methods: BANK, CALL_CENTER, ONLINE, PAPER.

Enum

 

 

Merchant Type

Represents the type of the Merchant

Values: ONLINE, RETAIL, BOTH.

Enum

Y

 

Unique Code

Specifies the unique product code requested.

 

 

 

Quantity

Represents the quantity

 

 

 

Product Inventory Id

Represents the Inventory ID

Application inventory

 

 

Transaction Currency

 

 

 

 

Settlement Currency

The Currency code with which the Settlement gets processed to merchants. It needs to be compatible with the Currency from Acquirer.

Currency

 

 

Business Entity

It specifies the Merchants Business entity.

Example: Company, Individual, Partnership, Society etc.

Enum

Y

 

Mcc For Business

Specifies the business type

String

Y

 

Mcc For Business Other

Specifies the business type

String

Y

 

Incorporation Date

Represents the Business entity started Date in the application.

Local date

Y

 

Establishment Details

Represents all the establishment details of the merchant.

Establishment

Y

 

Legal Name

Specifies the legal name

String

Y

 

Establishment address

Specifies the establishment address.

String

 

 

Lines

Street name

String

 

 

City

Establishment address City name

String

 

 

State

Establishment address state name

String

 

 

State ID

Establishment address State ID

 

 

 

County

Establishment address country name

String

 

 

Pin code

Establishment address pin code

 

 

 

Land mark

Establishment address land mark

 

 

 

Country code numeric

Country code 3-digit number

 

 

 

Region

Region name

 

 

 

Country code

Specifies the Country code of the merchant.

String

 

 

Number

Specifies the merchant mobile number.

String

 

 

Establishment Email Id

Specifies establishment email id

String

 

 

Country Of Incorporation

Represents the Business entity country name in the application.

String

Y

 

Email Confirmed

Email verified indicator

Boolean (True/False)

 

 

Document name

Name of the document

 

 

 

Document number

Specifies the document number

 

 

 

Document image

Document image need to be uploaded

 

 

 

Document description

Description of the document

 

 

 

Is this mandatory

Mandatory indicator

Boolean (True/False)

 

 

First Owner name

Owners first name

String

 

 

Last Name

First owners last name

String

 

 

DBA owner name

DBA owner name

String

 

 

Gender

Gender confirmation

Enum

 

 

Date Of Birth

Format “YYYY-MM-DD”

 

 

 

Current Address lines

Current address of the first owner

String

 

 

Region

Region name

String

 

 

Email

Email ID of the first owner

String

 

 

Country code

Specifies the Country code of the merchant.

String

 

 

Number

Specifies the merchant mobile number.

String

 

 

Document name

Name of the document

String

 

 

Document number

Specifies the document number

 

 

 

Document image

Document image need to be uploaded

 

 

 

Document description

Description of the document

String

 

 

Is this mandatory

Mandatory indicator

Boolean (True/False)

 

 

Face of Owner

Owner picture      

Second Owner Name

Specifies the second owner’s name String    

Owner DBA Name

DBA owner name

String

   

Current address

Current address of the second owner

String

   

Region

Region name

String

   
Mobile Number

Mobile number of the second owner

String

   

Document name

Name of the document

String

   

Document number

Specifies the document number

 

   

Document image

Document image need to be uploaded

 

 

 

Document description

Description of the document

String

 

 

Is this mandatory

Mandatory indicator

Boolean (True/False)

 

 

Debit Account details

Represents the merchant debit account details.

Bank details

Y

 

Account first Name

Debit account first name

String

Y

 

Last Name

Debit account last name

String

Y

 

Account Number

Debit account number

String

Y

 

Bank Name

Name of the bank

String

Y

 

IFSC Code

IFSC code of the bank

String

Y

 

Payment Mode

Mode of payment e.g.: NEFT

Enum

 

 

Account Type

Account type

 

 

 

Split Payment code

Payment code

 

 

 

Split value

Split payment value

 

 

 

Split code

Split payment code

 

 

 

Step Date

Date in format YYYY-MM-DD

 

 

 

Step ID

Step id name

 

 

 

Before Status

“SUBMITTED” fixed value

 

 

 

After Status

“APPROVED” fixed value

 

 

 

Step Action

“APPROVE” fixed value

 

 

 

Action Date

Date and time in format” 2021-06-28T13:07:29.6819231”

 

 

 

User ID

ID name

 

 

 

Step Comments

Comments as mentioned

 

 

 

Step ID

Step id name

 

 

 

Before Status

“SUBMITTED” fixed value

 

 

 

After Status

“APPROVED” fixed value

 

 

 

Step Action

“APPROVE” fixed value

 

 

 

Action Date

Date and time in format” 2021-06-28T13:07:29.6819231”

 

 

 

Current Processing action

Current processing step name

 

 

 

Processing status

“MERCHANT_SUCCESSFULLY_BOARDED” statue name

 

 

 

Under writing

Under writer steps

 

 

 

Merchant screening

Merchant screening

 

 

 

1

I st step screening

 

 

 

Criteria Name

Specifies the criteria name

 

 

 

Allowed Range

Criteria allowed range digits

Enum

 

 

Initial Score

Initial score digit

 

 

 

Weightage

Weightage digit

 

 

 

Selected Range

Specifies the digit

 

 

 

2

2nd step screening

 

 

 

Criteria Name

Specifies the criteria name

 

 

 

Allowed Range

Criteria allowed range digits

Enum

 

 

Initial Score

Initial score digit

 

 

 

Weightage

Weightage digit

 

 

 

Selected Range

Specifies the digit

 

 

 

3

3rd step screening

 

 

 

Criteria Name

Specifies the criteria name

 

 

 

Allowed Range

Criteria allowed range digits

Enum

 

 

Initial Score

Initial score digit

 

 

 

Weightage

Weightage digit

 

 

 

Selected Range

Specifies the digit

 

 

 

Merchant class and Risk Profiling criteria name

1st Criteria name

 

 

 

Allowed Range

Criteria allowed range digits

Enum

 

 

Initial Score

Initial score digit

 

 

 

Weightage

Weightage digit

 

 

 

Selected Range

Specifies the digit

 

 

 

Allowed Range

Criteria allowed range digits

 

 

 

Merchant site Verification criteria name

 1stCriteria name

 

 

 

Allowed Range

Criteria allowed range digits

Enum

 

 

Initial Score

Initial score digit

 

 

 

Weightage

Weightage digit

 

 

 

Selected Range

Specifies the digit

 

 

 

Merchant credit worthiness criteria name

1stCriteria name

 

 

 

Allowed Range

Criteria allowed range digits

Enum

 

 

Initial Score

Initial score digit

 

 

 

Weightage

Weightage digit

 

 

 

Selected Range

Specifies the digit

 

 

 

2 criteria names

2nd criteria name

 

 

 

Allowed Range

Criteria allowed range digits

Enum

 

 

Initial Score

Initial score digit

 

 

 

Weightage

Weightage digit

 

 

 

Selected Range

Specifies the digit

 

 

 

Risk Range

Specifies the risk range

 

 

 

1

1st risk range

 

 

 

Range

Specifies range in digits

 

 

 

Category

Specifies the category” MEDIUM”

 

 

 

Action

“REFER” action value

 

 

 

Low Range

Low risk range -digit value

 

 

 

High Range

High risk range-digit value

 

 

 

2

2nd risk range

 

 

 

Range

Specifies range in digits

 

 

 

Category

Specifies the category” MEDIUM”

 

 

 

Action

“REFER” action value

 

 

 

Low Range

Low risk range -digit value

 

 

 

High Range

High risk range-digit value

 

 

 

3

3rd risk range

 

 

 

Range

Specifies range in digits

 

 

 

Category

Specifies the category” MEDIUM”

 

 

 

Action

“REFER” action value

 

 

 

Low Range

Low risk range -digit value

 

 

 

High Range

High risk range-digit value

 

 

 

4

4th risk range

 

 

 

Range

Specifies range in digits

 

 

 

Category

Specifies the category” POTENTIAL FRAUDLENT”

 

 

 

Action

“REFER” action value

 

 

 

Low Range

Low risk range -digit value

 

 

 

High Range

High risk range-digit value

 

 

 

Merchant Application Evaluation

Specifies the merchant application evaluation

 

 

 

1

1st step of merchant application evaluation

 

 

 

Step Description

“REQUIRED_DOC_UPLOAD” fixed value

 

 

 

Sequence

Sequence order

 

 

 

Required

Required indicator

Boolean (True/False)

 

 

Batch Real

BATCH name

 

 

 

Action for Failed

“REFER” fixed value

 

 

 

Is Seriously Rejected

Rejection indicator

Boolean (True/False)

 

 

System Group Model Key

Model key value” 5f05eaee841a8d272e497e02”

 

 

 

2

2nd step of merchant application evaluation

 

 

 

Step Description

“CHECK_DUPLICATE” fixed value

 

 

 

Sequence

Sequence order

 

 

 

Required

Required indicator

Boolean (True/False)

 

 

Batch Real

BATCH name

 

 

 

Action for Failed

“REFER” fixed value

 

 

 

Is Seriously Rejected

Rejection indicator

Boolean (True/False)

 

 

System Group Model Key

Model key value” 5f05eaee841a8d272e497e02”

 

 

 

3

3rd step of merchant application evaluation

 

 

 

Step Description

“BLACKLISTED_PINCODE” fixed value

 

 

 

Sequence

Sequence order

 

 

 

Required

Required indicator

Boolean (True/False)

 

 

Batch Real

BATCH name

 

 

 

Action for Failed

“REFER” fixed value

 

 

 

Is Seriously Rejected

Rejection indicator

Boolean (True/False)

 

 

System Group Model Key

Model key value” 5f05f3ce841a8d272e497e54”

 

 

 

4

4th step of merchant application evaluation

 

 

 

Step Description

“FRAUD_CHECK” fixed value

 

 

 

Sequence

Sequence order

 

 

 

Required

Required indicator

Boolean (True/False)

 

 

Batch Real

BATCH name

 

 

 

Action for Failed

“REFER” fixed value

 

 

 

Is Seriously Rejected

Rejection indicator

Boolean (True/False)

 

 

System Group Model Key

Model key value” 5f05f3ce841a8d272e497e54”

 

 

 

5

5th step of merchant application evaluation

 

 

 

Step Description

“REJECT_FILE_CHECK” fixed value

 

 

 

Sequence

Sequence order

 

 

 

Required

Required indicator

Boolean (True/False)

 

 

Batch Real

BATCH name

 

 

 

Action for Failed

“REFER” fixed value

 

 

 

Is Seriously Rejected

Rejection indicator

Boolean (True/False)

 

 

System Group Model Key

Model key value” 5f05ec9b841a8d272e497e1b”

 

 

 

6

6th step of merchant application evaluation

 

 

 

Step Description

“SCHEME_TERMINATED” fixed value

 

 

 

Sequence

Sequence order

 

 

 

Required

Required indicator

Boolean (True/False)

 

 

Batch Real

BATCH name

 

 

 

Action for Failed

“REFER” fixed value

 

 

 

Is Seriously Rejected

Rejection indicator

Boolean (True/False)

 

 

System Group Model Key

Model key value” 5f05f2c7841a8d272e497e42”

 

 

 

7

7th step of merchant application evaluation

 

 

 

Step Description

“CHECK_BUREAU” fixed value

 

 

 

Sequence

Sequence order

 

 

 

Required

Required indicator

Boolean (True/False)

 

 

Batch Real

BATCH name

 

 

 

Action for Failed

“REFER” fixed value

 

 

 

Is Seriously Rejected

Rejection indicator

Boolean (True/False)

 

 

System Group Model Key

Model key value” 5f05ec9b841a8d272e497e1b”

 

 

 

8

8th step of merchant application evaluation

 

 

 

Step Description

“IF_STP” fixed value

 

 

 

Sequence

Sequence order

 

 

 

Required

Required indicator

Boolean (True/False)

 

 

Batch Real

BATCH name

 

 

 

Action for Failed

“REFER” fixed value

 

 

 

Is Seriously Rejected

Rejection indicator

Boolean (True/False)

 

 

System Group Model Key

Model key value” 5f05f2e4841a8d272e497e44”

 

 

 

9

9th step of merchant application evaluation

 

 

 

Step Description

“CHECK_CUSTOM2” fixed value

 

 

 

Sequence

Sequence order

 

 

 

Required

Required indicator

Boolean (True/False)

 

 

Batch Real

BATCH name

 

 

 

Action for Failed

“REFER” fixed value

 

 

 

Is Seriously Rejected

Rejection indicator

Boolean (True/False)

 

 

System Group Model Key

Model key value” 5f05ec9b841a8d272e497e1b”

 

 

 

10

10th step of merchant application evaluation

 

 

 

Step Description

“CHECK_CUSTOM3” fixed value

 

 

 

Sequence

Sequence order

 

 

 

Required

Required indicator

Boolean (True/False)

 

 

Batch Real

BATCH name

 

 

 

Action for Failed

“REFER” fixed value

 

 

 

Is Seriously Rejected

Rejection indicator

Boolean (True/False)

 

 

System Group Model Key

Model key value” 5f05f357841a8d272e497e4c”

 

 

 

11

11th step of merchant application evaluation

 

 

 

Step Description

“CONTACT_POINT_VERIFICATION” fixed value

 

 

 

Sequence

Sequence order

 

 

 

Required

Required indicator

Boolean (True/False)

 

 

Batch Real

BATCH name

 

 

 

Action for Failed

“REFER” fixed value

 

 

 

Is Seriously Rejected

Rejection indicator

Boolean (True/False)

 

 

System Group Model Key

Model key value” 5f05ec9b841a8d272e497e1b”

 

 

 

12

12th step of merchant application evaluation

 

 

 

Step Description

“DOC_VERIFICATION” fixed value

 

 

 

Sequence

Sequence order

 

 

 

Required

Required indicator

Boolean (True/False)

 

 

Batch Real

BATCH name

 

 

 

Action for Failed

“REFER” fixed value

 

 

 

Is Seriously Rejected

Rejection indicator

Boolean (True/False)

 

 

System Group Model Key

Model key value” 5f05f394841a8d272e497e50”

 

 

 

13

13th step of merchant application evaluation

 

 

 

Step Description

“WEBSITE_VERIFICATION” fixed value

 

 

 

Sequence

Sequence order

 

 

 

Required

Required indicator

Boolean (True/False)

 

 

Batch Real

BATCH name

 

 

 

Action for Failed

“REFER” fixed value

 

 

 

Is Seriously Rejected

Rejection indicator

Boolean (True/False)

 

 

System Group Model Key

Model key value” 5f05ec9b841a8d272e497e1b”

 

 

 

14

14th step of merchant application evaluation

 

 

 

Step Description

“UNDERWRITING” fixed value

 

 

 

Sequence

Sequence order

 

 

 

Required

Required indicator

Boolean (True/False)

 

 

Batch Real

BATCH name

 

 

 

Action for Failed

“REFER” fixed value

 

 

 

Is Seriously Rejected

Rejection indicator

Boolean (True/False)

 

 

System Group Model Key

Model key value” 5f05ec9b841a8d272e497e1b”

 

 

 

15

15th step of merchant application evaluation

 

 

 

Step Description

“CHECK_CUSTOM1” fixed value

 

 

 

Sequence

Sequence order

 

 

 

Required

Required indicator

Boolean (True/False)

 

 

Batch Real

BATCH name

 

 

 

Action for Failed

“REFER” fixed value

 

 

 

Is Seriously Rejected

Rejection indicator

Boolean (True/False)

 

 

System Group Model Key

Model key value” 5f05f323841a8d272e497e48”

 

 

 

16

16th step of merchant application evaluation

 

 

 

Step Description

“BUSINESS_APPROVAL” fixed value

 

 

 

Sequence

Sequence order

 

 

 

Required

Required indicator

Boolean (True/False)

 

 

Batch Real

BATCH name

 

 

 

Action for Failed

“REFER” fixed value

 

 

 

Is Seriously Rejected

Rejection indicator

Boolean (True/False)

 

 

System Group Model Key

Model key value” 5f05f378841a8d272e497e4e”

 

 

 

Merchant Number

Merchant application number 15 digits

 

 

 

Successful Boarding Date

Date in format” 2021-06-28”

 

 

 

Merchant Model key

Model key value

 

 

 

Acquired by comp

Indicator

Boolean (True/False)

 

 

Step Flow

Step flow names

 

 

 

1

"REQUIRED_DOC_UPLOAD"

 

 

 

2

"CHECK_DUPLICATE"

 

 

 

3

"BLACKLISTED_PINCODE"

 

 

 

4

"FRAUD_CHECK"

 

 

 

5

"REJECT_FILE_CHECK"

 

 

 

6

"SCHEME_TERMINATED"

 

 

 

7

"CHECK_BUREAU"

 

 

 

8

"IF_STP"

 

 

 

9

"CHECK_CUSTOM2"

 

 

 

10

"CHECK_CUSTOM3"

 

 

 

11

"CONTACT_POINT_VERIFICATION"

 

 

 

12

"DOC_VERIFICATION"

 

 

 

13

"WEBSITE_VERIFICATION"

 

 

 

14

"UNDERWRITING"

 

 

 

15

"CHECK_CUSTOM1"

 

 

 

16

"BUSINESS_APPROVAL"

 

 

 

Uw Merchant Priority

Specifies the under-writer merchant priority

String

 

 

Merchant Profile

Represents merchant profile assigned by the UW.

 

 

 

Statement Type

It specifies the statement type used by the Merchant.

Values: DETAILED, SUMMARY, NONE.

Enum

 

 

Existing account

Account indicator

Boolean (True/False)

 

 

Is Opted for DCC

DCC indicator

Boolean (True/False)

 

 

Is Card Accept International

International card acceptance Indicator

Boolean (True/False)

 

 

Is International Delivery

International Delivery indicator

Boolean (True/False)

 

 

Is STP Qualified

Stp qualified indicator

Boolean (True/False)

 

 

Cpv Retail check name

It contains the list of fields that need to check at boarding time for CPV retail merchants

String

 

 

Check Description

Description of cheque

 

 

 

Is Check Performed

Check performed indicator

Boolean (True/False)

 

 

Business Area

Business area name

String

 

 

Check Name

Check name

String

 

 

Check Description

Description of cheque

 

 

 

Is Check Performed

Check performed indicator

Boolean (True/False)

 

 

Business Area

Business area name

String

 

 

Cpv online check name

It contains the list of fields that need to check at boarding time for CPV online merchants.

String

 

 

Check Description

Description of cheque

 

 

 

Is Check Performed

Check performed indicator

Boolean (True/False)

 

 

Check Name

Check name

String

 

 

Check Description

Description of cheque

 

 

 

Is Check Performed

Check performed indicator

Boolean (True/False)

 

 

Document Check name

Document check name

String name

 

 

Check Description

“Check all docs” description

 

 

 

Is Check Performed

Check performed indicator

Boolean (True/False)

 

 

Website Checklist

Website check name

String

 

 

Check Name

Website check name

 

 

 

Check Description

“Verify website” description

 

 

 

Is Check Performed

Check performed indicator

Boolean (True/False)

 

 

Is User Reassigned

User reassigned indicaor

 

 

 

Is Split Payment

Split Payment indicator

Boolean (True/False)

 

 

Split Refund Needed

Refund indicator

Boolean (True/False)

 

 

Merchant Credit Accounts

Merchant’s credit Account details.

Bank details

Y

 

Account first Name

Credit account first name

String

Y

 

Last Name

Credit account last name

String

Y

 

Account Number

Credit account number

String

Y

 

Bank Name

Name of the bank

String

Y

 

IFSC Code

IFSC code of the bank

String

Y

 

Payment Mode

Mode of payment e.g.: NEFT

Enum

 

 

Account Type

Account type

 

 

 

Split Payment code

Payment code

 

 

 

Split Amount value

Split payment value

 

 

 

code

Split payment code

 

 

 

Mc activation

Mc activation indicator

Boolean (True/False)

 

 

Ben Action

Ben action value

 

 

 

IP Address

IP address

 

 

 

Smid

 

 

 

 

{messageID: "/api/application/submit", requestType: "CREATE",…
}
messageID: "/api/application/submit"
object: {id: "60939f22702a326a81b9396c", applicationStatus: "SUBMITTED"
}
applicationStatus: "SUBMITTED"
id: "60939f22702a326a81b9396c"
requestType: "CREATE"
 
"requestType": "UPDATE",
"success": true,
"object": {
    "id": "6059c2946e97ae1a44e4d3ba",
    "applicationNumber": "154534583733381568",
    "applicationStatus": "BOARDED_SUCCESSFULL",
    "currentProcessingStep": "SUCCESSFULLY_BOARDED",
    "submitDate": "2021-06-28",
    "applicantName": {
        "firstName": "PaynextApplication",
        "lastName": "Testfour"
    },
    "applicantEmailId": "[email protected]",
    "mobileNumber": {
        "countryCode": "91",
        "number": "6547890431"
    },
    "inputSource": "BANK_WEB",
    "inputSourceID": "sri",
    "merchantType": "ONLINE",
    "productRequested": [
        {
            "uniqueCode": "mMC",
            "quantity": 1,
            "productInventoryId": "5e216a01a1fbdb0eb2ad17a3"
        },
        {
            "uniqueCode": "PSTN",
            "quantity": 2,
            "productInventoryId": "P100123"
        },
        {
            "uniqueCode": "INTERNET_GATEWAY",
            "quantity": 1,
            "productInventoryId": "PG0001"
        }
    ],
    "transactionCurrency": "INR",
    "settlementCurrency": "INR",
    "businessEntity": "GOVERNMENT",
    "mccForBusiness": "EDUCATIONAL_SERVICES",
    "inCorporationDate": "1998-02-02",
    "establishmentDetails": {
        "legalName": "Paynext application Test4",
        "establishmentAddress": {
            "lines": "MainRoad",
            "city": "Srikakulam",
            "state": "ANDHRA PRADESH",
            "country": "India",
            "pincode": "532404",
            "landmark": "Gara",
            "countryCodeNumeric": "356",
            "region": "AP"
        },
        "mobileNumber": {
            "countryCode": "91",
            "number": "6543210987"
        },
        "establishmentEmailId": "[email protected]",
        "countryOfIncorporation": "in",
        "emailConfirmed": false,
        "docToBeUploaded": [
            {
                "name": "PAN",
                "number": "PAN6789",
                "image": {},
                "documentDescription": "PAN proof",
                "isThisMandatory": true
            }
        ]
    },
    "firstOwnerList": {
        "ownerName": {
            "firstName": "PaynextApplication",
            "lastName": "Testfour"
        },
        "ownerDBAName": {},
        "gender": "FEMALE",
        "dateOfBirth": "1979-12-31",
        "currentAddress": {
            "region": "AP"
        },
        "emailId": "[email protected]",
        "mobileNumber": {
            "countryCode": "91",
            "number": "6543789023"
        },
        "docToBeUploaded": [
            {
                "name": "DL",
                "number": "DL8900",
                "image": {},
                "documentDescription": "DL proof",
                "isThisMandatory": false
            },
            {
                "name": "Passport",
                "image": {},
                "documentDescription": "Passport number",
                "isThisMandatory": false
            },
            {
                "name": "Voter Id",
                "image": {},
                "documentDescription": "Voter Id Number"
            }
        ],
        "faceOfOwner": {}
    },
    "secondOwnerList": {
        "ownerName": {},
        "ownerDBAName": {},
        "currentAddress": {
            "region": "AP"
        },
        "mobileNumber": {},
        "docToBeUploaded": [
            {
                "name": "DL",
                "image": {},
                "documentDescription": "DL proof",
                "isThisMandatory": false
            },
            {
                "name": "Passport",
                "image": {},
                "documentDescription": "Passport number",
                "isThisMandatory": false
            },
            {
                "name": "Voter Id",
                "image": {},
                "documentDescription": "Voter Id Number"
            }
        ]
    },
    "debitAccountDetails": {
        "accountname": {
            "firstName": "PAYNEXT",
            "lastName": "aPPLICATION4"
        },
        "accountNumber": "1283471982374",
        "bankName": "RBL",
        "ifscCode": "1234",
        "paymentMode": "NEFT",
        "accountType": "CURRENT",
        "splitPaymentCode": "1",
        "splitAmount": {
            "value": 0,
            "code": "INR"
        }
    },
    "auditTrail": {
        "1": {
            "stepDate": "2021-06-28",
            "stepId": "CREATE_MERCHANT_MASTER",
            "beforeStatus": "SUBMITTED",
            "afterStatus": "APPROVED",
            "stepAction": "APPROVE",
            "actionDate": "2021-06-28T13:07:29.6819231",
            "userId": "SYS",
            "stepComments": "Step has been Approved"
        }
    },
    "stepTrail": {
        "1": {
            "stepId": "CREATE_MERCHANT_MASTER",
            "beforeStatus": "APPROVED",
            "afterStatus": "APPROVED",
            "stepAction": "APPROVE"
        }
    },
    "currentProcessingAction": "APPROVE",
    "processingStatus": "MERCHANT_SUCCESSFULLY_BOARDED",
    "underwriting": {
        "merchantScreening": {
            "1": {
                "criteriaName": "test1",
                "allowedRang": [
                    1,
                    2,
                    4
                ],
                "initialScore": 0,
                "weightage": 10,
                "selectedRange": 0
            },
            "2": {
                "criteriaName": "test2",
                "allowedRang": [
                    1,
                    2,
                    3,
                    4
                ],
                "initialScore": 0,
                "weightage": 10,
                "selectedRange": 0
            },
            "3": {
                "criteriaName": "step3",
                "allowedRang": [
                    0,
                    2,
                    3,
                    4,
                    5
                ],
                "initialScore": 0,
                "weightage": 10,
                "selectedRange": 0
            }
        },
        "merClassAndRiskProfiling": {
            "1": {
                "criteriaName": "test4",
                "allowedRang": [
                    1,
                    5
                ],
                "initialScore": 0,
                "weightage": 10,
                "selectedRange": 0
            }
        },
        "merSiteVerification": {
            "1": {
                "criteriaName": "tes5",
                "allowedRang": [
                    0,
                    2,
                    4
                ],
                "initialScore": 0,
                "weightage": 30,
                "selectedRange": 0
            }
        },
        "merchantCreditworthiness": {
            "1": {
                "criteriaName": "test5",
                "allowedRang": [
                    0,
                    1
                ],
                "initialScore": 0,
                "weightage": 15,
                "selectedRange": 0
            },
            "2": {
                "criteriaName": "test5",
                "allowedRang": [
                    0,
                    3
                ],
                "initialScore": 0,
                "weightage": 15,
                "selectedRange": 0
            }
        },
        "riskRange": {
            "1": {
                "range": 71,
                "category": "LOW",
                "action": "APPROVE",
                "lowRange": 1,
                "highRange": 25
            },
            "2": {
                "range": 50,
                "category": "MEDIUM",
                "action": "REFER",
                "lowRange": 26,
                "highRange": 45
            },
            "3": {
                "range": 30,
                "category": "HIGH",
                "action": "REFER",
                "lowRange": 46,
                "highRange": 60
            },
            "4": {
                "range": 20,
                "category": "POTENTIAL_FRAUDULENT",
                "action": "REJECT",
                "lowRange": 61,
                "highRange": 100
            }
        }
    },
    "merchantApplicationEvaluation": {
        "1": {
            "stepDescription": "REQUIRED_DOC_UPLOAD",
            "sequence": 1,
            "required": false,
            "batchReal": "BATCH",
            "actionForFailed": "REFER",
            "isSeriouslyRejected": false,
            "systemGroupModelKey": "5f05eaee841a8d272e497e02"
        },
        "2": {
            "stepDescription": "CHECK_DUPLICATE",
            "sequence": 2,
            "required": false,
            "batchReal": "BATCH",
            "actionForFailed": "REFER",
            "isSeriouslyRejected": false,
            "systemGroupModelKey": "5f05eb46841a8d272e497e04"
        },
        "3": {
            "stepDescription": "BLACKLISTED_PINCODE",
            "sequence": 3,
            "required": false,
            "batchReal": "BATCH",
            "actionForFailed": "REFER",
            "isSeriouslyRejected": false,
            "systemGroupModelKey": "5f05f3ce841a8d272e497e54"
        },
        "4": {
            "stepDescription": "FRAUD_CHECK",
            "sequence": 4,
            "required": false,
            "batchReal": "BATCH",
            "actionForFailed": "REFER",
            "isSeriouslyRejected": false,
            "systemGroupModelKey": "5f05ec12841a8d272e497e17"
        },
        "5": {
            "stepDescription": "REJECT_FILE_CHECK",
            "sequence": 5,
            "required": false,
            "batchReal": "BATCH",
            "actionForFailed": "REFER",
            "isSeriouslyRejected": false,
            "systemGroupModelKey": "5f05ec9b841a8d272e497e1b"
        },
        "6": {
            "stepDescription": "SCHEME_TERMINATED",
            "sequence": 6,
            "required": false,
            "batchReal": "BATCH",
            "actionForFailed": "REFER",
            "isSeriouslyRejected": false,
            "systemGroupModelKey": "5f05f2c7841a8d272e497e42"
        },
        "7": {
            "stepDescription": "CHECK_BUREAU",
            "sequence": 7,
            "required": false,
            "batchReal": "BATCH",
            "actionForFailed": "REFER",
            "isSeriouslyRejected": false,
            "systemGroupModelKey": "5f05f303841a8d272e497e46"
        },
        "8": {
            "stepDescription": "IF_STP",
            "sequence": 8,
            "required": false,
            "batchReal": "BATCH",
            "actionForFailed": "APPROVE",
            "isSeriouslyRejected": false,
            "systemGroupModelKey": "5f05f2e4841a8d272e497e44"
        },
        "9": {
            "stepDescription": "CHECK_CUSTOM2",
            "sequence": 9,
            "required": false,
            "batchReal": "BATCH",
            "actionForFailed": "APPROVE",
            "isSeriouslyRejected": false,
            "systemGroupModelKey": "5f05f342841a8d272e497e4a"
        },
        "10": {
            "stepDescription": "CHECK_CUSTOM3",
            "sequence": 10,
            "required": false,
            "batchReal": "BATCH",
            "actionForFailed": "APPROVE",
            "isSeriouslyRejected": false,
            "systemGroupModelKey": "5f05f357841a8d272e497e4c"
        },
        "11": {
            "stepDescription": "CONTACT_POINT_VERIFICATION",
            "sequence": 11,
            "required": false,
            "batchReal": "BATCH",
            "actionForFailed": "REFER",
            "isSeriouslyRejected": false,
            "systemGroupModelKey": "5f05f2ab841a8d272e497e40"
        },
        "12": {
            "stepDescription": "DOC_VERIFICATION",
            "sequence": 12,
            "required": false,
            "batchReal": "BATCH",
            "actionForFailed": "REFER",
            "isSeriouslyRejected": false,
            "systemGroupModelKey": "5f05f394841a8d272e497e50"
        },
        "13": {
            "stepDescription": "WEBSITE_VERIFICATION",
            "sequence": 13,
            "required": false,
            "batchReal": "BATCH",
            "actionForFailed": "REFER",
            "isSeriouslyRejected": false,
            "systemGroupModelKey": "5f05f3b4841a8d272e497e52"
        },
        "14": {
            "stepDescription": "UNDERWRITING",
            "sequence": 14,
            "required": false,
            "batchReal": "BATCH",
            "actionForFailed": "REFER",
            "isSeriouslyRejected": false,
            "systemGroupModelKey": "5f05f28f841a8d272e497e3e"
        },
        "15": {
            "stepDescription": "CHECK_CUSTOM1",
            "sequence": 15,
            "required": false,
            "batchReal": "BATCH",
            "actionForFailed": "APPROVE",
            "isSeriouslyRejected": false,
            "systemGroupModelKey": "5f05f323841a8d272e497e48"
        },
        "16": {
            "stepDescription": "BUSINESS_APPROVAL",
            "sequence": 16,
            "required": false,
            "batchReal": "BATCH",
            "actionForFailed": "REFER",
            "isSeriouslyRejected": false,
            "systemGroupModelKey": "5f05f378841a8d272e497e4e"
        }
    },
    "merchantNumber": "262527963365376",
    "successfullBoardingDate": "2021-06-28",
    "merchantModelKey": "60d97c36f161b750cf4dc58d",
    "acquiredByComp": false,
    "stepFlow": {
        "1": "REQUIRED_DOC_UPLOAD",
        "2": "CHECK_DUPLICATE",
        "3": "BLACKLISTED_PINCODE",
        "4": "FRAUD_CHECK",
        "5": "REJECT_FILE_CHECK",
        "6": "SCHEME_TERMINATED",
        "7": "CHECK_BUREAU",
        "8": "IF_STP",
        "9": "CHECK_CUSTOM2",
        "10": "CHECK_CUSTOM3",
        "11": "CONTACT_POINT_VERIFICATION",
        "12": "DOC_VERIFICATION",
        "13": "WEBSITE_VERIFICATION",
        "14": "UNDERWRITING",
        "15": "CHECK_CUSTOM1",
        "16": "BUSINESS_APPROVAL"
    },
    "uwMerchantPriority": "NON_PREMIER",
    "merchantProfile": "5f9fbaefde60eb529a776a1b",
    "statementType": "SUMMARY",
    "existingAccount": false,
    "isOptedForDCC": false,
    "isCardAcceptInternational": false,
    "isInternationalDelivery": false,
    "isStpQualified": false,
    "cpvRetailCheckList": [
        {
            "checkName": "name1",
            "checkDescription": "desc",
            "isCheckPerformed": false,
            "businessArea": "OFFICE"
        },
        {
            "checkName": "name2",
            "checkDescription": "desc2",
            "isCheckPerformed": false,
            "businessArea": "HEADOFFICE"
        },
        {
            "checkName": "name3",
            "checkDescription": "desc3",
            "isCheckPerformed": false,
            "businessArea": "PRIMARYOWNER"
        },
        {
            "checkName": "name4",
            "checkDescription": "desc4",
            "isCheckPerformed": false,
            "businessArea": "OFFICE"
        }
    ],
    "cpvOnlineCheckList": [
        {
            "checkName": "name3",
            "checkDescription": "desc3",
            "isCheckPerformed": false
        },
        {
            "checkName": "name4",
            "checkDescription": "desc4",
            "isCheckPerformed": false
        }
    ],
    "documentCheckList": [
        {
            "checkName": "doc ver",
            "checkDescription": "check all docs",
            "isCheckPerformed": false
        },
        {
            "checkName": "docs ver1",
            "checkDescription": "test",
            "isCheckPerformed": false
        },
        {
            "checkName": "docs ver2",
            "checkDescription": "testing",
            "isCheckPerformed": false
        },
        {
            "checkName": "GST verification",
            "checkDescription": "GST verification",
            "isCheckPerformed": false
        }
    ],
    "websiteCheckList": [
        {
            "checkName": "website",
            "checkDescription": "Verify website",
            "isCheckPerformed": false
        },
        {
            "checkName": "website1",
            "checkDescription": "web",
            "isCheckPerformed": false
        },
        {
            "checkName": "website2",
            "checkDescription": "webs",
            "isCheckPerformed": false
        }
    ],
    "isUserReassigned": false,
    "isSplitPayment": false,
    "splitRefundNeeded": false,
    "merchantCreditAccounts": [
        {
            "accountname": {
                "firstName": "PAYNEXT",
                "lastName": "aPPLICATION4"
            },
            "accountNumber": "1283471982374",
            "bankName": "RBL",
            "ifscCode": "1234",
            "paymentMode": "NEFT",
            "accountType": "CURRENT",
            "splitPaymentCode": "1",
            "splitAmount": {
                "value": 0,
                "code": "INR"
            }
        }
    ],
    "mcActivation": false,
    "benAction": "0",
    "ipaddress": "127.0.1.1",
    "smid": "PrasannaTesting"
}
}
 
Error Desciption:- EXTERNAL_SERVER_ERROR_OCCURRED
Onboarding Login Request

This API can be used to check the status of the merchant application and if the status is “Saved”, rest of the details can be filled in and submitted. Response would contain the status of the application.

API URL

api/auth/onboarding/login request

HTTP Method

POST

REQ/RES TYPE

Application/JSON

Field name Description Data type Mandatory Length

Message ID

Message ID for validate OTP request

Sting

 

 

Object

Request Content

-

 

 

Application number

Specifies the application number

Number

Y

 

Login credentials

“APPLICATION NUMBER” fixed value

Sting

Y

 

Login hash

Login hash code

 

 

Request type

“UPDATE” fixed value string

Sting

 

 

Onboarding Login Response
Field name Description Data type Mandatory Length

Object

Response content

-

 

 

Id

ID number

 

 

 

Application number

Specifies the application number

 

 

 

Application status

“IN-PROGRESS” (fixed value)

String

 

 

Acquired by comp

Acquired by company indicator

Boolean (True/False)

 

 

Assigned to model key

It specifies the assigned system user for the application.

String

 

 

Applicant email ID

It stores the email Id of the applicant.

String

 

 

First name

Specifies the merchant’s first name.

String

Y

 

Last name

Specifies the merchant’s last name.

String

 

 

Application number

Specifies the application number

 

 

 

Application status

“IN-PROGRESS” (fixed value)

String

 

 

Ben action

 

 

 

 

Credit Bureau Score Update Date

Specifies the Credit score calculated date.

Local date

 

 

Credit Bureau Score

Specifies the Credit bureau score of each merchant.

Integer

 

 

Date Created

represents the date on which the application has started

Local date

 

 

Establishment Details

Represents all the establishment details of the merchant.

Establishment

Y

 

Existing Account

Existing account indicator

Boolean (True/False)

 

 

First Owner List

Represents all the details of the First Owner.

Owner details

Y

 

Id

Request ID

String

 

 

Input Source

Represents the exact source, with which the Merchant is trying to connect.

Values: BANK_APP, BANK_INTERNAL_APP, BANK_WEB, DSA, MERCHANT_APP, SELF_PORTAL, SM.

Enum

 

 

Input source ID

Represents input source name

String

 

 

Ip address

Saves the IP address from where the Merchant is trying to board. Format: 127.0.1.1 String    

Is Card Accept International

International card acceptance Indicator Boolean (True/False)    

Is International Delivery

International Delivery indicator Boolean (True/False)    

Is Opted for DCC

DCC indicator Boolean (True/False)    

Is Report Mandatory

Report Mandatory indicator Boolean (True/False)    

Is Split Payment

Split Payment indicator Boolean (True/False)    

Is Stp Qualified

Stp qualified indicator Boolean (True/False)    

Is User Reassigned

User Reassigned indicator Boolean (True/False)    

Login hash

Represents the login hash code      
Mc Activation Mc Activation indicator Boolean (True/False)    
Mcc For Business Specifies the business type String Y  

Merchant Type

Represents the type of the Merchant

Values: ONLINE, RETAIL, BOTH.
Enum    

Country code

 The Country code of the merchant.

String

 

 

Number

Specifies the merchant mobile number.

String

 

 

Second Owner List

Represents all the details of the Second Owner.

String

 

 

Smid

 

 

 

 

Split refund needed

Split refund Indicator

Boolean (True/False)

 

 

Statement Type

It specifies the statement type used by the Merchant.

Values: DETAILED, SUMMARY, NONE.

Enum

 

 

UW Merchant priority

Specifies the under-writer merchant priority

String

 

 

Success

Success indicator

Boolean (True/False)

 

 

Token

Token ID

 

 

 

messageID: "/api/auth/onBoarding/login"
object: {loginCredentials: "APPLICATION_NUMBER",…
}
applicationNumber: "413191026946545088"
loginCredentials: "APPLICATION_NUMBER"
loginHash: "6c3f2992e37335c728f2c2359d94e782d99b3531fcc36d7a33c2e7afe69b3fb8a0e9a4873d437dcdc02bcb82a89376fe06240fd12da9e5fac7dee1f9ae97942a"
requestType: "UPDATE"
 
object: {id: "60ebdb50c0b9e04650103681", applicationNumber: "201260644743902496", applicationStatus: "SAVED",…
}
acquiredByComp: false
allianceOrgModelKey: "6092447b225dfd4f72dd738f"
applicantEmailId: "[email protected]"
applicantName: {firstName: "Test", lastName: "app"
}
firstName: "Test"
lastName: "app"
applicationNumber: "201260644743902496"
applicationStatus: "SAVED"
benAction: "0"
creditBereauScoreUpdateDate: "2021-07-12"
creditBureauScore: 701
dateCreated: "2021-07-12"
establishmentDetails: {legalName: "Check",…
}
existingAccount: false
firstOwnerList: {ownerName: {}, ownerDBAName: {}, currentAddress: {region: "AP"
    }, mobileNumber: {},…
}
id: "60ebdb50c0b9e04650103681"
inputSource: "BANK_WEB"
inputSourceID: "krishhna"
ipaddress: "127.0.1.1"
isCardAcceptInternational: false
isInternationalDelivery: false
isOptedForDCC: false
isReportMandatory: false
isSplitPayment: false
isStpQualified: false
isUserReassigned: false
loginHash: "cfe1e9a26ee012eb23a67e19cb6c49fbdfb83d8abf943229b34f4f6eeac8024bd22a4138144e37a64e3349fb5f7a373e7c3c598de478da92262e6bbfd510a1ab"
mcActivation: false
merchantType: "RETAIL"
mobileNumber: {countryCode: "+91", number: "9000000000"
}
secondOwnerList: {ownerName: {}, ownerDBAName: {}, currentAddress: {region: "AP"
    }, mobileNumber: {},…
}
smid: "prasanna"
splitRefundNeeded: false
statementType: "SUMMARY"
uwMerchantPriority: "NON_PREMIER"
success: true
token: "eyJhbGciOiJIUzI1NiJ9.eyJzdWIiOiJTRUxGQVBQQDIwMTI2MDY0NDc0MzkwMjQ5NiIsImlhdCI6MTYyNjA3MDMxOSwiZXhwIjoxNjI2MDc3NTE5fQ.JeWp9355sARcw8fg0ZlgFbKuypTJg6DS3g2xivmYc60"
 
Error Description: - Object received as null. So, ignoring further process.
Normal Authorization Request

This API can be used to test a normal authorization. Response would contain authorization status.

API URL

api/authorization/normalAuthorizationRequestVo

HTTP Method

POST

REQ/RES TYPE

Application/JSON

Field name Description Data type Mandatory Length

Message ID

Message ID for normal authorization request

String

 

 

Object

Request content

-

 

 

DCC Markup amount

Markup amount for the DCC transaction

Big Decimal

 

 

DCC Markup percentage

Markup percentage for the DCC transaction

Bibdecimal

 

 

Select card type

Card type selection

Enum

 

 

Acquirer ID assigned by Scheme

Acquirer ID number

String

 

 

Card Data Input Capability

 Terminal static data that will be fixed Scheme wise - will be shared upfront

String

 

 

Card expiry

Encrypted Expiry date

String

 

 

Card Key Index

24 char hex key Index

String

 

 

Card Number

Encrypted card number

String

 

 

Cardholder Authentication Method

Terminal static data that will be fixed Scheme wise - will be shared upfront

String

 

 

Cashback Amount

Cashback Amount

Big Decimal

 

 

Country Code

Numeric country code

String

 

 

Credit Or Debit Enum

Fee type – Credit / Debit

Enum

 

 

de3FromAccount

From account based on card used

String

 

 

de3ToAccount

To account generally 00

String

 

 

Emi Amount

Emi Amount

BigDecimal

 

 

Emi Margin Amount

Emi Margin Amount

Bigdecimal

 

 

Fee Amount

Fee Amount

BigDecimal

 

 

Forwarding ID

Forwarding ID – Scheme wise Static data shared upfront separately

String

 

 

Invoice Number

Invoice reference

String

 

 

MOTO Ecom Payment

Terminal static data that will be fixed Scheme wise - will be shared upfront

String

 

 

mcc

4 char MCC

String

 

 

Merchant Number

15 char MID

String

 

 

Message Sub Type

Fixed value "NORMAL_AUTH"

Enum

 

 

Message Type

Fixed value "AUTH"

Enum

 

 

Pan Entry Mode

PAN entry mode – Transaction - wise Static data will be shared upfront separately

Enum

 

 

Partial Auth

 

 

 

 

Pin Capture Capability

Pin Capture Capability

String

 

 

Pin Entry Mode

PIN entry mode – Transaction - wise Static data will be shared upfront separately

Enum

 

 

Pos Condition Code

 

Enum

 

 

Sale Date

Date in format "2021-05-11T08:30:00.000Z"

LocalDate

 

 

Sale Time

Time in format hh: mm: ss

LocalTime

 

 

Scheme Code

Scheme code “VISA”

Enum

 

 

Special CondInd

Special condition

String

 

 

Terminal Number

Terminal ID

String

 

 

Terminal Operating Environment

Terminal Operating Environment

String

 

 

Terminal Type

Terminal type “POS”

Enum

 

 

Tip Surcharge Amount

Tip Amount

BigDecimal

 

 

Tran Amt In Merchant Currency

Currency “INR”

BigDecimal

 

 

Transaction Currency

Currency in ISO alphabet format

Currency

 

 

Transaction amount

Transaction Amount with decimal

BigDecimal

 

 

Request Type

“CREATE” fixed value

 

 

 

Normal Authorization Response
Field name Description Data type Mandatory Length

Object

Response content

-

 

 

Acquirer ID assigned by Scheme

Acquirer ID number

String

 

 

Auth Code

Authorization Code received from Authorizer

String

 

 

Authorization Response Code

Authorization Response Code value

String

 

 

Card Data Input Capability

Card Data Input Capability value

String

 

 

Card Key Index

24 char hex key Index

String

 

 

Cardholder Authentication Method

Terminal static data that will be fixed Scheme wise - will be shared upfront

String

 

 

Cashback Amount

Cashback Amount

BigDecimal

 

 

Country Code

Numeric country code

String

 

 

Crd hld Act Term Lvl

 

String

 

 

DCC mark up amount

DCC amount

BigDecimal

 

 

DCC Markup Percentage

DCC Markup Percentage

Bigdecimal

 

 

de3FromAccount

From account based on card used

String

 

 

de3ToAccount

To account generally 00

String

 

 

Emi Amount

Emi Amount

BigDecimal

 

 

Emi Margin Amount

Emi Margin Amount

BigDecimal

 

 

Error message

Error text

String

 

 

Fee Amount

Fee Amount

BigDecimal

 

 

Forwarding ID

Forwarding ID – Scheme wise Static data shared upfront separately

String

 

 

Invoice Number

Invoice reference

String

 

 

IS dcc transaction

DCC transaction indicator

Boolean (True/False)

 

 

Mcard terminal Attendance

Mcard terminal Attendance

String

 

 

mcc

4 char MCC

String

 

 

Merchant location

Merchant Location as in Switch

String

 

 

Merchant name

Merchant Name as in Switch

String

 

 

Merchant Number

15 char MID

String

 

 

Message Sub Type

Fixed value "NORMAL_AUTH"

Enum

 

 

Message Type

Fixed value "AUTH"

Enum

 

 

Pan Entry Mode

PAN entry mode – Transaction - wise Static data will be shared upfront separately

Enum

 

 

Partial Auth

Auth code

String

 

 

Pin Capture Capability

Pin Capture Capability

String

 

 

Pin Entry Mode

PIN entry mode – Transaction - wise Static data will be shared upfront separately

Enum

 

 

Pos Condition Code

Pos Condition Code

Enum

 

 

Request ID

Request ID

String

 

 

Source

Source “WEB”

 

 

 

RRN

Retrieval Reference number generated for the transaction

String

 

 

Sale Date

Date in format "2021-05-11T08:30:00.000Z"

LocalDate

 

 

Sale Time

Time in format hh: mm: ss

LocalTime

 

 

Scheme Code

Scheme based on Card BIN

Enum

 

 

Special CondInd

Special Condition

String

 

 

SYS Audit trance

System Audit trace generated in switch

String

 

 

Terminal Number

Terminal ID

String

 

 

Terminal Operating Environment

Terminal Operating Environment

String

 

 

Terminal pin code

Pin code value

String

 

 

Tip Surcharge Amount

Tip Amount

BigDecimal

 

 

Tran Amt In Merchant Currency

Currency “INR”

BigDecimal

 

 

Transaction Currency

Currency in ISO alphabet format

Currency

 

 

Transaction amount

Transaction Amount with decimal

Bigdecimal

 

 

Success

Success indicator

Boolean (True/False)

 

 

messageID: "/api/authorization/NormalAuthorizationRequestVO"
object: {dccMarkupAmount: {code: "INR"
    }, dccMarkupPercentage: {code: "INR"
    },…
}
SelectCardType: "MAG_CARD"
acquirerIDassignedbyScheme: "10223344"
cardDataInputCapability: "0"
cardExpiry: "FeQksQLYgJNxOjEbS2GZTWz7xPEiLmlOgw61WR9vdkbUOpDycIZRoKK9DByy1nWLkfBV9GU0Xo+oK9TxPD3o/YTsBEUlEeKlPLRJTI4Wdc3d1O6+jX/BYkY/RoVTK9M6SDBrtPppYxqFy0B9KEyOL6+6gUpxzJDpYPmgZqIxmG95p6CGY1SdF65AX6Y01Bl1FQByiuYIsBMg7pGIFVP/4fQPSX551pQM/yNaTPkrnSW5BcZwG54bcVcSa5o9SICXrTVHu9Ad+ijQ5h1Bbf9FEf+pM2F0ub2xiievwqya2sYi7uRtYpnl8mkyaE60s2vJqMfhIvjMmVZCJggHOAn6RA=="
cardKeyIndex: "609a40aee115e564b801ee7e"
cardNumber: "ZREzuft1vE+oKNCNDCIKb2hRtlAx1Sgvwuz7AbeTEZkYkXLCTaC43KFFJKMCgE7urWw7ZD6Jid+uh0MnzxgXYoeaRNlizvnoLRqzbZmdPpxvIm+PwVg6MnC7G2pB0ETw63lfTNa8ie9GX9RQSRO9upt3rf6UMC3MPesfq5sBnJnuApykobd/f3t87S4AxKpIMg+87yiH7FTEFsqmAYXorq5wqFYMji82ZXxcdmTQI6OtfZKkvV5CdUZldg3bwwZAg7DQB6rm3B61gYr/tj0diXtZjwkCfEugB+PBDLV1v0FgOTgsvUEfXBD00ys2pCay77korrqy+WS6gYU3c/P/Zw=="
cardholderAuthenticationMethod: "1"
cashbackAmount: {code: "INR"
}
countryCode: "356"
creditOrDebitEnum: "CREDIT"
dccMarkupAmount: {code: "INR"
}
dccMarkupPercentage: {code: "INR"
}
de3FromAccount: "00"
de3ToAccount: "00"
emiAmount: {code: "INR"
}
emiMarginAmount: {code: "INR"
}
feeAmount: {code: "INR"
}
forwardingID: "10223355"
invoiceNumber: "10000001"
mOTOEcomPaymnt: "00"
mcc: "8062"
merchantNumber: "107183000077271"
messageSubType: "NORMAL_AUTH"
messageType: "AUTH"
panEntryMode: "VI_PANEntry_90_B"
partialAuth: "0"
pinCaptureCapability: "04"
pinEntryMode: "VI_PINEntry_0"
posConditionCode: "VI_POSCondCode_00"
saleDate: "2021-05-11T08:30:00.000Z"
saleTime: "14:00:38"
schemeCode: "VISA"
specialCondInd: "0"
terminalNumber: "10018837"
terminalOperatingEnvironment: "0"
terminalType: "POS"
tipSurchargeAmount: {code: "INR"
}
tranAmtInMerchantCurrency: {code: "INR"
}
transactionCurrency: "INR"
transactionamount: {code: "INR", value: "1000"
}
requestType: "CREATE"
 
object: {messageType: "AUTH", messageSubType: "NORMAL_AUTH", schemeCode: "VISA",…
}
acquirerIDassignedbyScheme: "10223344"
authCode: "000000"
authorizationResponseCode: "30"
cardDataInputCapability: "0"
cardKeyIndex: "609a40aee115e564b801ee7e"
cardholderAuthenticationMethod: "1"
cashbackAmount: {value: 0, code: "INR"
}
countryCode: "356"
crdhldActTermLvl: "0"
creditOrDebitEnum: "CREDIT"
dccMarkupAmount: {value: 0, code: "INR"
}
code: "INR"
value: 0
dccMarkupPercentage: {value: 0, code: "INR"
}
de3FromAccount: "00"
de3ToAccount: "00"
emiAmount: {value: 0, code: "INR"
}
emiMarginAmount: {value: 0, code: "INR"
}
errorMessage: "Encryption Technique Indicator invalid "
feeAmount: {value: 0, code: "INR"
}
code: "INR"
value: 0
forwardingID: "10223355"
invoiceNumber: "10000001"
isDCCTransaction: false
mcardterminalAttendance: "0"
mcc: "8062"
merchantLocation: "Krishna"
merchantName: "RBL APP5"
merchantNumber: "107183000077271"
messageSubType: "NORMAL_AUTH"
messageType: "AUTH"
panEntryMode: "VI_PANEntry_90_B"
partialAuth: "0"
pinCaptureCapability: "04"
pinEntryMode: "VI_PINEntry_0"
posConditionCode: "VI_POSCondCode_00"
requestID: "609a40aee115e564b801ee7e"
routing: {source: "WEB"
}
source: "WEB"
rrn: "113114003893"
saleDate: "2021-05-11"
saleTime: "14:00:38"
schemeCode: "VISA"
specialCondInd: "0"
sysAuditTrace: "003893"
terminalNumber: "10018837"
terminalOperatingEnvironment: "0"
terminalPincode: "520015"
tipSurchargeAmount: {value: 0, code: "INR"
}
tranAmtInMerchantCurrency: {value: 0, code: "INR"
}
transactionCurrency: "INR"
transactionamount: {value: 1000, code: "INR"
}
code: "INR"
value: 1000
success: false
 
Error Description: - 
1>SOS_0008_MESSAGE_VALIDATION_FAIL
2>INVALID_DATA_TYPE_PROVIDED
 
Error Codes
400 - Bad Request - Invalid input fields or fields are missing
401 - Unauthorized - API request with invalid credentials
403 - Forbidden - The device/merchant is not allowed for the transaction
415 - Invalid Format - The message format is not a valid JSON
422 - Incorrect Request - Some error exists in the data sent to the Host
500 - HTTP Internal Server Error - Request was not completed and server met an unexpected condition
501 - Invalid Format - The message format is not a valid JSON
502 - Bad Gateway - request was not completed and the server received unwanted response from upstream server
503 - Service Unavailable - Request was not completed and the server is temporarily overloading or down
504 - Gateway Timeout - Timeout
505 - Https version not supported - the server does not support the “http protocol” version
Any other - Undefined Error
 
Service Request Pre-Submit Request

This API can be used to trigger “Operating Timings” Service Request from the Merchant Self Service web/app. Response will contain the SR number assigned to the request if the SR was successfully raised

API URL

api/serviceRequest/ss/preSubmit

HTTP Method

POST

REQ/RES TYPE

Application/JSON

Field name Description Data type Mandatory Length

Message ID

Message ID for service request pre-submit

 String

 

 

Object

Request content

 -

 

 

Is Sr Number Required

 SR number indicator

 Boolean (True/False)

 

 

Merchant Model Key

 Model key value

 

 

 

Sr Sub Type

 Sr Sub Type "MERCHANT_LEVEL"

 

 

 

Sr Type

 Sr type "OPERATING_TIMES"

 

 

 

Request Type

 "CREATE" fixed value

 

 

 

Service Request Pre-Submit response
Field name Description Data type Mandatory Length

Object

Response content

String

 

 

Chain name

Chain name

String

 

 

Chain number

Represents Chain number

String

 

 

Country code

Merchant’s country code

String

 

 

Number

Merchant’s mobile number

String

 

 

Current Processing Date Time

Date in format "2021-05-12T00:00:00"

Local Date Time

 

 

Email

Merchant’s email ID

String

 

 

Is Checker Approval

Checker approve indicator

Boolean (True/False)

 

 

Is Fee Displayed

Fee display indicator

Boolean (True/False)

 

 

Is Otp Req

OTP indicator

Boolean (True/False)

 

 

Is Schedule Date

Schedule Date indicator

Boolean (True/False)

 

 

Merchant Name

Merchant Name

String

 

 

Merchant Number

Displays Merchant number

String

 

 

Registered Add

Registered address of the merchant

String

 

 

Pin code

6-digit pin code

String

 

 

Sr Number

Service request number

String

 

 

Success

Success indicator

Boolean (True/False)

 

 

messageID: "/api/serviceRequest/ss/preSubmit"
object: {merchantModelKey: "5f17052cad3d8175948970e4", srType: "OPERATING_TIMES", srSubType: "MERCHANT_LEVEL",…
}
isSrNumberRequired: true
merchantModelKey: "5f17052cad3d8175948970e4"
srSubType: "MERCHANT_LEVEL"
srType: "OPERATING_TIMES"
requestType: "CREATE"
 
object: {srNumber: "SRN954878566662", merchantNumber: "545454545454545",…
}
chainName: "name"
chainNumber: "589794639247576704"
contact: {countryCode: "+91", number: "7787787878"
}
currentProcessingDateTime: "2021-05-12T00:00:00"
email: "[email protected]"
isCheckerApproval: false
isFeeDisplayed: false
isOtpReq: false
isScheduleDate: true
merchantName: "name"
merchantNumber: "545454545454545"
registeredAdd: {lines: "fds", city: "Karim Nagar", state: "TELANGANA", country: "India", pincode: "504293",…
}
srNumber: "SRN954878566662"
success: true
 
1>isSrNumberNeeded should not be null
2>SrSubType should not be null
3>SR Type should not be null
 
Merchant Domain Inquiry Request

This API can be used to inquiry a merchant record using the merchant number. Response will contain all the details related to the merchant inquired.

API URL

api/merchantDomain/SS/inq

HTTP Method

POST

REQ/RES TYPE

Application/JSON

Field name Description Data type Mandatory Length

Message ID

Message ID for merchant domain inquiry

 String

 

 

Object

Request content

-

 

 

Id

Request ID

String

 

 

Merchant Model Key

Model key value

String

Y

 

Request Type

"QUERY" fixed value

 

 

 

Merchant Domain Inquiry Response
Field name Description Data type Mandatory Length

 object

Response content

 

 

 

 Alliance Org Model Key

Model key value

String

 

 

 Ben Id

Ben ID "BENTOUCANPAYM1231
9182819281"

String

 

 

 certified

Certified indicator

Boolean (True/False)

 

 

 Chain Model Key

Chain model key value

String

 

 

 Chain Number

Chain Number

String

 

 

 Cycle Date

Number of days

String

 

 

 Id

Request ID

String

 

 

Is Banner Activated

Banner activation indicator

Boolean (True/False)

 

 

Is Card Accept International

International card accept indicator

Boolean (True/False)

 

 

Is Chain Present

Chain present indicator

Boolean (True/False)

 

 

Is Convenience Fee Enabled

Convenience fee enabled indicator

Boolean (True/False)

 

 

Is Convenience Fee Included

Convenience fee Included indicator

Boolean (True/False)

 

 

Is Email Activated

Email activation indicator

Boolean (True/False)

 

 

Is Notification Activated

Notification indicator

Boolean (True/False)

 

 

Is Opted For DCC

DCC indicator

Boolean (True/False)

 

 

Is SMS Activated

SMS indicator

Boolean (True/False)

 

 

Is Split Payment

Split payment indicator

Boolean (True/False)

 

 

Is Surcharge Fee Enabled

Surcharge fee Enabled indicator

Boolean (True/False)

 

 

Is Surcharge Fee Included

Surcharge fee Included indicator

Boolean (True/False)

 

 

Is Whatsapp Activated

Whatapp indicator

Boolean (True/False)

 

 

Last Statement Date

Date in format "2021-05-03"

Local date

 

 

Mc Activation

Mc Activation indicator

Boolean

 

 

Mcc Code

4 char MCC code

String

 

 

Mcc Description

MCC name

 

 

 

Mer Market Data Identifier

 

String

 

 

Merchant Application Model Key

Model key value

String

 

 

Event name

"SERVICE_REQUEST_CREATION" fixed value

Enum

 

 

First name

Merchant first name as per bank account

String

Y

 

Last name

Merchant last name as per bank account

String

 

 

Account number

Merchant credit account number

String

 

 

Merchant Currency

Merchant Currency ”INR”

Currency

 

 

Merchant Debit Account

Merchant Debit Account details

String

 

 

ID

Request ID

String

 

 

List of merchant numbers

Value

 

 

 

Merchant Name

Merchant Name

String

 

 

Merchant Number

Merchant ID

String

 

 

Merchant Priority

Merchant Priority “NON_PREMIER”

Enum

 

 

Merchant Profile

Merchant Profile number

String

 

 

Merchant Segment

Merchant segment “PLATINUM"

 

 

 

 

Merchant Status

“ACTIVE” fixed value

String

 

 

Merchant Type

Merchant Type

Enum

 

 

Merchant WebDev Mode

Merchant WebDev Mode “CUSTOMER”

String

 

 

nextMembershipDate

Date in format "2021-09-14"

Local date

 

 

nextStatementDate

Date in format "2021-06-03"

Local date

 

 

nextTurnoverfeeCalculationDate

Date in format "2021-07-21"

Local date

 

 

noOfDaysForPreAuth

Numeric value 1

 

 

 

noOfDaysPostTransaction

Numeric value 1

 

 

 

Offer code

Code value

String

 

 

Enroll start date

Start date format "2020-12-01"

Local date

 

 

Enroll end date

End date format "2020-12-31"

Local date

 

 

Payment Advise

Payment Advise "MERCHANT"

 

 

 

Payment Frequency

No of transaction days

Number

 

 

Payment Level

Payment level "MERCHANT_LEVEL"

 

 

 

Posting Identifier

"AUTHORIZATION" fixed value

Enum

 

 

Real Time Settlement

Real time settlement indicator

Boolean (True/False)

 

 

Settlement Currency

Currency” INR”

 

 

 

Should Admin Fee Be Waived

Admin Fee waiver indicator

Boolean (True/False)

 

 

Should Chargeback Fee Be Waived

Chargeback Fee waiver indicator

Boolean (True/False)

 

 

Should Deinstallation Fee Be Waived

Deinstallation Fee waiver indicator

Boolean (True/False)

 

 

Should Dup Email StmtFeeBeWaived

Duplicate email statement fee waiver indicator

Boolean (True/False)

 

 

Should Dup Stmt Fee Be Waived

Duplicate statement fee waiver indicator

Boolean (True/False)

 

 

shouldFallbackFeeBeWaived

Fallback fee waiver indicator

Boolean (True/False)

 

 

shouldLateFeeBeWaived

Late fee waiver indicator

Boolean (True/False)

 

 

shouldOneTProcessFeeBeWaived

One TProcess fee waiver indicator

Boolean (True/False)

 

 

shouldPaymentAdviseEmailFeeBeWaived

PaymentAdviseEmailFee indicator

Boolean (True/False)

 

 

shouldPaymentAdviseFeeBeWaived

PaymentAdviseFee indicator

Boolean (True/False)

 

 

shouldPaymentBeOnHold

Payment on hold indicator

Boolean (True/False)

 

 

Should Rebate Be Waived

Rebate indicator

Boolean (True/False)

 

 

Should Replacement Fee Be Waived

Replacement fee waiver indicator

Boolean (True/False)

 

 

Should Setup Fee Be Waived

Setup fee indicator

Boolean (True/False)

 

 

shouldSupplyFeeBeWaived

Supply fee indicator

Boolean (True/False)

 

 

shouldTurnoverFeeBeWaived

Tuen over fee waiver indicator

Boolean (True/False)

 

 

shouldUserFeeBeWaived

User fee indicator

Boolean (True/False)

 

 

shouldmembershipFeeBeWaived

Membership fee indicator

Boolean (True/False)

 

 

shouldmiscFeeBeWaived

Misc fee indicator

Boolean (True/False)

 

 

shouldnonSuffFeeBeWaived

Non stuff fee waiver indicator

Boolean (True/False)

 

 

shouldserviceFeeBeWaived

Service fee indicator

Boolean (True/False)

 

 

shouldstatementFeeBeWaived

Statement fee indicator

Boolean (True/False)

 

 

splitRefundNeeded

Split refund indicator

Boolean (True/False)

 

 

statement Frequency

Statement frequency” MONTHLY”

Enum

 

 

statement Level

statement Level “MERCHANT”

Enum

 

 

statement Mode

statement Mode “EMAIL”

Enum

 

 

statement Type

statement Type” SUMMARY”

Enum

 

 

statusChangeDate

Sate in format "2020-09-07"

Local date

 

 

terAutoSettleSLa

 

 

 

 

Transaction Mode

AUTHORIZATION_AND_PURCHASE fixed value

Enum

 

 

Request Type

"QUERY" fixed value

String

 

 

Success

Success indicator

Boolean (True/False)

 

 

messageID: "/api/merchantDomain/ss/inq"
object: {id: "5f17052cad3d8175948970e4", merchantModelKey: "5f17052cad3d8175948970e4"
}
id: "5f17052cad3d8175948970e4"
merchantModelKey: "5f17052cad3d8175948970e4"
requestType: "QUERY"
 
object: {id: "5f17052cad3d8175948970e4", merchantNumber: "545454545454545", merchantName: "name",…
}
allianceOrgModelKey: "5ee9e1dc739bf642f875991f"
benId: "BENTOUCANPAYM12319182819281"
certified: true
chainModelKey: "60389659c95e435a63cbd641"
chainNumber: "589794639247576704"
cycleDate: "21"
id: "5f17052cad3d8175948970e4"
isBannerActivated: true
isCardAcceptInternation: false
isChainPresent: true
isConvenienceFeeEnabled: false
isConvenienceFeeIncluded: false
isEmailActivated: true
isNotificationActivated: true
isOptedForDCC: false
isSMSActivated: true
isSplitPayment: false
isSurchargeFeeEnabled: false
isSurchargeFeeIncluded: false
isWhatsappActivated: true
lastStatementDate: "2021-05-03"
mcActivation: false
mccCode: "0763"
mccDescription: "Agricultural cooperatives"
merMarketDataIdentifier: "N"
merchantApplicationModelKey: "5f16ff5dad3d8175948970cf"
merchantCommunicationList: [
    {eventName: "SERVICE_REQUEST_CREATION", isWhatsappActivated: true, isBannerActivated: true,…
    }
]
merchantCreditAccounts: [
    {accountname: {firstName: "Asutosh", lastName: "Padhi"
        }, accountNumber: "309002027948",…
    }
]
merchantCurrency: "INR"
merchantDebitAccount: {accountname: {firstName: "Asutosh", lastName: "Padhi"
    }, accountNumber: "309002027948",…
}
merchantDemographics: {id: "5f17052cad3d8175948970e3", listOfMerchantNumbers: {
        1: "545454545454545"
    },…
}
merchantName: "name"
merchantNumber: "545454545454545"
merchantPriority: "NON_PREMIER"
merchantProfile: "5f9fbaefde60eb529a776a1b"
merchantSegment: "PLATINUM"
merchantStatus: "ACTIVE"
merchantType: "BOTH"
merchantWebDevMode: "CUSTOMER"
nextMembershipDate: "2021-09-14"
nextStatementDate: "2021-06-03"
nextTurnoverfeeCalculationDate: "2021-07-21"
noOfDaysForPreAuth: 1
noOfDaysPostTransaction: 1
offers: [
    {offerCode: "offer8", enrollStartDate: "2020-12-01", enrollEndDate: "2020-12-31",…
    },…
]
paymentAdvise: "MERCHANT"
paymentFrequency: "TXN_nDAYS"
paymentLevel: "MERCHANT_LEVEL"
postingIdentifier: "AUTHORIZATION"
realTimeSettlement: false
settlementCurrency: "INR"
shouldAdminFeeBeWaived: false
shouldChargebackFeeBeWaived: false
shouldDeInstallationFeeBeWaived: false
shouldDupEmailStmtFeeBeWaived: false
shouldDupStmtFeeBeWaived: false
shouldFallbackFeeBeWaived: false
shouldLateFeeBeWaived: false
shouldOneTProcessFeeBeWaived: false
shouldPaymentAdviseEmailFeeBeWaived: false
shouldPaymentAdviseFeeBeWaived: false
shouldPaymentBeOnHold: false
shouldRebateBeWaived: false
shouldReplacementFeeBeWaived: false
shouldSetupFeeBeWaived: false
shouldSupplyFeeBeWaived: false
shouldTurnoverFeeBeWaived: false
shouldUserFeeBeWaived: false
shouldmembershipFeeBeWaived: false
shouldmiscFeeBeWaived: false
shouldnonSuffFeeBeWaived: false
shouldserviceFeeBeWaived: false
shouldstatementFeeBeWaived: false
splitRefundNeeded: false
statementFrequency: "MONTHLY"
statementLevel: "MERCHANT"
statementMode: "EMAIL"
statementType: "SUMMARY"
statusChangeDate: "2020-09-07"
terAutoSettleSLa: "06:00"
transactionMode: "AUTHORIZATION_AND_PURCHASE"
requestType: "QUERY"
success: true
 
Error Description: - Record Not Found
Merchant Self Service – Service request inquiry

This API can be used to inquire the status of the Service Request raised for/by the merchant using the unique SR number assigned to the request. This API can be triggered from Merchant Self Service web/app. Response will contain the status of the SR.

API URL

api/consumables/ss/inq

HTTP Method

POST

REQ/RES TYPE

Application/JSON

Consumables Inquiry Request
Field name Description Data type Mandatory Length

Message ID

Message ID for consumables

 

 

 

object

Request content

 

 

 

id

Request ID

String

Y

 

Merchant Model Key

Model key value

 

 

 

Request Type

"QUERY" fixed value

String

 

 

Consumables Inquiry Response
Field name Description Data type Mandatory Length

object

Response content

 

 

 

ID

Request ID

String

 

 

Service request type

“CONSUMBALES” fixed value

String

 

 

city

Merchant city name

String

 

 

country

Merchant country name

String

 

 

landmark

Landmark name

String

 

 

lines

Street name

String

 

 

Pin code

Merchant area pin code

String

 

 

region

Region name

String

 

 

state

State name

String

 

 

Assigned To

Assigned member name

String

 

 

Assigned User Group

Assigned user group name

String

 

 

Chain Name

Chain Name

String

 

 

Chain Number

Chain ID

String

 

 

Delivery Option

Selected Delivery option

Enum

 

 

Expected Closure Date

Date in format "2021-05-24"

LocalDate

 

 

External User Model Key

Model key value

LocalDate

 

 

id

Service request ID

String

 

 

Inventory Code

Code value "P10008"

String

 

 

Is OTP Verified

OTP verified Indicator

Boolean (True/False)

 

 

Is Sla Cross

Sla crossed Indicator

Boolean (True/False)

 

 

Is User Reassigned

User reassigned Indicator

Boolean (True/False)

 

 

Merchant Email Id

Merchant’s Email Id

String

 

 

Merchant Model Key

Model key value

String

 

 

Merchant Name

Displays merchant name

String

 

 

Merchant Number

Merchant number

String

 

 

Number of Paper Roll

Numeric value

String

 

 

Primary Contact

Merchant primary contact number

String

 

 

priority

Priority value

Enum

 

 

Raised By

Merchant name

String

 

 

Scheduled Date

Date in format "2021-05-24"

LocalDate

 

 

Secondary Contact

Merchant secondary contact number

String

 

 

Service Request Date Time

Date and time format "2021-05-12T15:48:19.523"

LocalDateTime

 

 

Service Request Sub Type

Service Request Sub Type name

String

Y

 

Service Request Type

"CONSUMABLES" fixed value

Enum

Y

 

source

Source name "WEB"

Enum

 

 

Sr Category

"EXTERNAL" fixed value

Enum

 

 

Sr Status

"OPEN" fixed value

Enum

 

 

Request Type

"QUERY" fixed value

Enum

 

 

success

Success Indicator

Boolean (True/False)

 

 

messageID: "/api/consumables/ss/inq"
object: {id: "SRN336801548212", merchantModelKey: "5f17052cad3d8175948970e4"
}
id: "SRN336801548212"
merchantModelKey: "5f17052cad3d8175948970e4"
requestType: "QUERY"
 
object: {id: "SRN336801548212", serviceRequestType: "CONSUMABLES",…
}
address: {lines: "fds", city: "Karim Nagar", state: "TELANGANA", country: "India", pincode: "504293",…
}
city: "Karim Nagar"
country: "India"
landmark: "sdf"
lines: "fds"
pincode: "504293"
region: "AP"
state: "TELANGANA"
assignedTo: "venkat123"
assignedUserGroup: "5ec3580a3d0f1b5c0439abdf"
chainName: "name"
chainNumber: "589794639247576704"
deliveryOption: "DELIVERY"
expectedClosureDate: "2021-05-24"
externalUserModelKey: "O0Fzjoz1Oy"
id: "SRN336801548212"
inventoryCode: "P10008"
isOtpVerified: true
isSlaCross: false
isUserReassigned: false
merchantEmailId: "[email protected]"
merchantModelKey: "5f17052cad3d8175948970e4"
merchantName: "name"
merchantNumber: "545454545454545"
numberOfPaperRoll: 2
primaryContact: {number: "7787787878"
}
priority: "LOW"
raisedBy: "O0Fzjoz1Oy"
scheduledDate: "2021-05-24"
secondaryContact: {}
serviceRequestDateTime: "2021-05-12T15:48:19.523"
serviceRequestSubType: "LARGE_HIGH_PAPERROLL"
serviceRequestType: "CONSUMABLES"
source: "WEB"
srCategory: "EXTERNAL"
srStatus: "OPEN"
requestType: "QUERY"
success: true
 
Error Description: -Record Not FOUND
Application Submit Request

API URL

api/allp/application/submit

HTTP Method

POST

REQ/RES TYPE

Application/JSON

Field name Description Data type Mandatory Length

Message ID

Message ID for application submit request

String

 

 

Object

Object content

-

 

 

Application status

Specifies the application status “SUBMITTED”

Enum

 

 

ID

Specifies the request ID

String

Y

 

Request type

CREATE (Fixed value)

String

 

 

Application Submit Response
Field name Description Data type Mandatory Length

Request type

 

Sting

 

 

Object

Request content

-

 

 

Acquired by comp

Acquired by company indicator

Boolean (True/False)

 

 

Applicant email ID

It stores the email Id of the applicant.

String

 

 

First name

Specifies the merchant’s first name.

String

Y

 

Last name

Specifies the merchant’s last name.

String

 

 

Application number

Specifies the application number

 

 

 

Application status

“IN-PROGRESS” (fixed value)

String

 

 

Assigned to model key

It specifies the assigned system user for the application.

String

 

 

Audit trail

Step by step actions performed before submission of application.

 

 

 

Ben action

 

String

 

 

Business entity

It specifies the Merchants Business entity.

Example: Company, Individual, Partnership, Society etc.

Enum

Y

 

certified

Specifies whether merchants are certified for PCI/DSS.

Boolean (True/False)

 

 

Contact list

Represents all the details of the Contact person involved.

Contact person

 

 

CPV Online check list

It contains the list of fields that need to check at boarding time for CPV online merchants.

Boarding Field Check

 

 

Cpv Retail check list

It contains the list of fields that need to check at boarding time for CPV retail merchants

 

 

 

Credit Bureau Score Update Date

Specifies the Credit score calculated date.

Local date

 

 

Credit Bureau Score

Specifies the Credit bureau score of each merchant.

Integer

 

 

Current Processing Action

Represents the exact step that is processing during the Onboarding process.

Action steps: APPROVE, REFER, REJECT, START.

Enum

 

 

Current Processing Step

The status of the current processing application.

Enum

 

 

Date Created

represents the date on which the application has started

Local date

 

 

Debit Account Details

Represents the merchant debit account details.

Bank details

Y

 

Document Check List

It contains the list of fields that need to check the required documents.

Boarding Field Check

 

 

Establishment Details

Represents all the establishment details of the merchant.

Establishment

Y

 

Existing Account

Existing account indicator

Boolean (True/False)

 

 

First Owner List

Represents all the details of the First Owner.

Owner details

Y

 

Frequency of Statement

Specifies the merchant’s statement frequency.

Frequencies: HALFYEARLY, MONTHLY, QUATERLY, YEARLY, NONE.

Enum

 

 

Id

Request ID

String

 

 

incorporation Date

Represents the Business entity started Date in the application.

Local date

Y

 

Info Method

Represents the approach method of merchants to Toucan application.

Methods: BANK, CALL_CENTER, ONLINE, PAPER.

Enum

 

 

Input Source

Represents the exact source, with which the Merchant is trying to connect.

Values: BANK_APP, BANK_INTERNAL_APP, BANK_WEB, DSA, MERCHANT_APP, SELF_PORTAL, SM.

Enum

 

 

Interface Language

Represents the interface language

Enum

 

 

Ip address

Saves the IP address from where the Merchant is trying to board. String    

isCardAcceptInternational

International card acceptance Indicator Boolean (True/False)    

isInternationalDelivery

International Delivery indicator Boolean (True/False)    

isOptedForDCC

DCC indicator Boolean (True/False)    

isReportMandatory

Report Mandatory indicator Boolean (True/False)    

Is Split Payment

Split Payment indicator Boolean (True/False)    

Is Stp Qualified

Stp qualified indicator Boolean (True/False)    

Is User Reassigned

User Reassigned indicator Boolean (True/False)    
Mc Activation Mc Activation indicator Boolean (True/False)    
Mcc For Business Specifies the business type String Y  

Merchant Type

Represents the type of the Merchant

Values: ONLINE, RETAIL, BOTH.
Enum Y  

Merchant Application Evaluation

 Merchant application evaluation details.

String

 

 

Merchant Credit Accounts

Merchant’s credit Account details.

Bank details

Y

 

Merchant Profile

Represents merchant profile assigned by the UW.

 

 

 

Merchant Type

Represents the type of the Merchant

Values: ONLINE, RETAIL, BOTH.

Enum

 

 

Merchant Web Dev Mode

It specifies the merchants web mode.

Modes: VENDOR, CUSTOMER, THIRD_PARTY.

Enum

 

 

Country code

 The Country code of the merchant.

String

 

 

Number

Specifies the merchant mobile number.

String

 

 

Mode of Statement

Specifies the merchant’s mode of Statement.

Values: EMAIL, MAIL, BOTH.

Enum

 

 

OTP

Specifies the OTP number sent to the User’s mobile number.

Integer

 

 

Payment Website Address

Represents the merchant’s payment website address.

String

 

 

Processing Status

It specifies the processing status of the saved application.

Enum

 

 

Unique code

Specifies the unique product code requested.

 

 

 

quantity

Represents the quantity

 

 

 

Product Inventory ID

Represents the Inventory ID

Application inventory

 

 

Reference Details

It holds the details of the Merchant, which are used in terms of reference.

String

 

 

Return URL

It specifies the return URL of the merchant business.

String

 

 

Sales Volume List

It stores the sales volume list of the application.

 

 

 

Second Owner List

Represents all the details of the Second Owner.

String

 

 

Settlement Currency

The Currency code with which the Settlement gets processed to merchants. It needs to be compatible with the Currency from Acquirer.

Currency

 

 

Smid

 

 

 

 

Split refund needed

Split refund Indicator

Boolean (True/False)

 

 

Statement Type

It specifies the statement type used by the Merchant.

Values: DETAILED, SUMMARY, NONE.

Enum

 

 

Statement send to

Specifies the owner’s name to whom the statement need to send.

 

 

 

Step flow

Specifies the step flow

 

 

 

Submit date

Specifies the application submitted date.

 

 

 

Transaction Mode

Specifies the mode of the transaction. Modes: AUTHORIZATION, AUTHORIZATION_AND_PURCHASE, PURCHASE.

Enum

 

 

UW Merchant priority

Specifies the under-writer merchant priority

String

 

 

Website Check List

It contains the list of fields that need to check for the website boarding.

Boarding Field Check

 

 

Request Type

” UPDATE” fixed value

String

 

 

Success

Success indicator

Boolean (True/False)

 

 

{messageID: "/api/application/submit", requestType: "CREATE",…
}
messageID: "/api/application/submit"
object: {id: "60939f22702a326a81b9396c", applicationStatus: "SUBMITTED"
}
applicationStatus: "SUBMITTED"
id: "60939f22702a326a81b9396c"
requestType: "CREATE"
 
object: {id: "60ec329ea0d8a62d2d3c2174", applicationNumber: "282177845426300768",…
}
acquiredByComp: false
allianceOrgModelKey: "5f0fe276df3feb27396c9441"
applicantEmailId: "[email protected]"
applicantName: {firstName: "yochana", lastName: "gud"
}
applicationNumber: "282177845426300768"
applicationStatus: "IN_PROGRESS"
auditTrail: {
    1: {stepDate: "2021-07-12", stepId: "REQUIRED_DOC_UPLOAD", beforeStatus: "SUBMITTED",…
    }
}
benAction: "0"
businessEntity: "COMPANY"
certified: true
contactList: {personName: {}, mobileNumber: {}, secondaryContactNumber: {}, landlineNumber: {}
}
cpvOnlineCheckList: [
    {checkName: "pg", checkDescription: "Description", isCheckPerformed: false
    }
]
cpvRetailCheckList: [
    {checkName: "test", checkDescription: "description", isCheckPerformed: false,…
    }
]
creditBereauScoreUpdateDate: "2021-07-12"
creditBureauScore: 300
currentProcessingAction: "START"
currentProcessingStep: "REQUIRED_DOC_UPLOAD"
dateCreated: "2021-07-12"
debitAccountDetails: {accountname: {firstName: "sdvfhjn", lastName: "cnhhhh"
    }, accountNumber: "12451451245121",…
}
documentCheckList: [
    {checkName: "fasd", checkDescription: "fdsa", isCheckPerformed: false
    }
]
establishmentDetails: {legalName: "silks brothers",…
}
existingAccount: false
failureUrl: "http://www.pay.com"
firstOwnerList: {ownerName: {firstName: "rao", lastName: "test"
    }, ownerDBAName: {}, gender: "FEMALE",…
}
frequencyOfStatement: "MONTHLY"
id: "60ec329ea0d8a62d2d3c2174"
inCorporationDate: "2021-06-01"
infoMethod: "ONLINE"
inputSource: "DSA"
inputSourceID: "testdoc"
interfaceLanguage: "ASP"
ipaddress: "127.0.1.1"
isCardAcceptInternational: false
isInternationalDelivery: false
isOptedForDCC: false
isReportMandatory: false
isSplitPayment: false
isStpQualified: false
isUserReassigned: false
mcActivation: false
mccForBusiness: "AIRLINES"
merchantApplicationEvaluation: {
    1: {stepDescription: "REQUIRED_DOC_UPLOAD", sequence: 1, required: true, batchReal: "BATCH",…
    },…
}
merchantCreditAccounts: [
    {accountname: {firstName: "sdvfhjn", lastName: "cnhhhh"
        }, accountNumber: "12451451245121",…
    }
]
merchantProfile: "609151b2ecaa5055ae57f5b7"
merchantType: "BOTH"
merchantWebDevMode: "CUSTOMER"
mobileNumber: {countryCode: "91", number: "8143836848"
}
modeOfStatement: "EMAIL"
paymentWebsiteAddress: "http://www.pay.com"
processingStatus: "DOCUMENT_CHECK_IS_IN_PROGRESS"
productRequested: [
    {uniqueCode: "mMC", quantity: 1, productInventoryId: "5e216a01a1fbdb0eb2ad17a3"
    }
]
referenceDetails: [
    {name: {}, referenceAddress: {region: "AP"
        }, contactNumber: {}, referenceIdProof: {image: {}
        }
    }
]
returnURL: "http://www.pay.com"
salesVolumeList: [
    {}
]
secondOwnerList: {ownerName: {}, ownerDBAName: {}, currentAddress: {region: "AP"
    }, previousAddress: {region: "AP"
    },…
}
settlementCurrency: "INR"
smid: "[email protected]"
splitRefundNeeded: false
statementType: "SUMMARY"
statmentSendTo: [
    "ESTABLISHMENT"
]
stepFlow: {
    1: "REQUIRED_DOC_UPLOAD",
    2: "CHECK_DUPLICATE",
    3: "FRAUD_CHECK",
    4: "REJECT_FILE_CHECK",…
}
stepTrail: {
    ,…
}
submitDate: "2021-07-12"
suggestedProfileModelKey: "609151b2ecaa5055ae57f5b7"
transactionMode: "AUTHORIZATION_AND_PURCHASE"
underwriting: {
    ,…
}
uwMerchantPriority: "NON_PREMIER"
websiteCheckList: [
    {checkName: "fsdaf", checkDescription: "fdsaf", isCheckPerformed: false
    }
]
requestType: "UPDATE"
success: true
 
Merchant Inquiry

This API can be used by the Alliance Partner/Aggregator to inquire a merchant under it using the unique Merchant ID assigned to it. Response will give all the details of that merchant.

API URL

api/merchantDomain/allp/inq

HTTP Method

POST

REQ/RES TYPE

Application/JSON

Field name Description Data type Mandatory Length

Message ID

 Message ID for merchant domain inquiry.

String

 

 

Object

 Request content

 -

 

 

Id

 Request ID

String

Y

 

Merchant Model Key

 Model key value

String

 

 

Request Type

“QUERY” fixed value

String

 

 

Response
Field name Description Data type Mandatory Length

 Object

 Response content

 

 

 

Alliance org model key

Model key value

String

 

 

Certified

 Certificate indicator

String

 

 

Comm profile override end date

 Date in format "2020-08-04"

LocalDate

 

 

 Comm profile override start date

 Date in format "2020-07-31"

LocalDate

 

 

Communication profile

Communication profile value

String

 

 

 Cycle Date

Number of days

String

 

 

 Id

Request ID

String

 

 

Is Banner Activated

Banner activation indicator

Boolean (True/False)

 

 

Is Card Accept International

International card accept indicator

Boolean (True/False)

 

 

Is Chain Present

Chain present indicator

Boolean (True/False)

 

 

Is Convenience Fee Enabled

Convenience fee enabled indicator

Boolean (True/False)

 

 

Is Convenience Fee Included

Convenience fee Included indicator

Boolean (True/False)

 

 

Is Email Activated

Email activation indicator

Boolean (True/False)

 

 

Is Notification Activated

Notification indicator

Boolean (True/False)

 

 

Is Opted For DCC

DCC indicator

Boolean (True/False)

 

 

Is SMS Activated

SMS indicator

Boolean (True/False)

 

 

Is Split Payment

Split payment indicator

Boolean (True/False)

 

 

Is Surcharge Fee Enabled

Surcharge fee Enabled indicator

Boolean (True/False)

 

 

Is Surcharge Fee Included

Surcharge fee Included indicator

Boolean (True/False)

 

 

Is Whatsapp Activated

Whatapp indicator

Boolean (True/False)

 

 

Last Statement Date

Date in format "2021-05-03"

LocalDate

 

 

Mc Activation

Mc Activation indicator

Boolean

 

 

Mcc Code

4 char MCC code

String

 

 

Mcc Description

MCC name

String

 

 

Mer Market Data Identifier

 

 

 

 

Merchant Application Model Key

Model key value

String

 

 

Event name

"SERVICE_REQUEST_CREATION" fixed value

Enum

 

 

First name

Merchant first name as per bank account

String

 

 

Last name

Merchant last name as per bank account

String

 

 

Account number

Merchant credit account number

String

 

 

Merchant Currency

Merchant Currency ”INR”

Currency

 

 

Merchant Debit Account

Merchant Debit Account details

String

 

 

ID

Request ID

String

 

 

List of merchant numbers

Value

String

 

 

Merchant Name

Merchant Name

String

 

 

Merchant Number

Merchant ID

String

 

 

Merchant Priority

Merchant Priority “NON_PREMIER”

Enum

 

 

Merchant Profile

Merchant Profile number

String

 

 

Merchant Segment

Merchant segment “PLATINUM"

 

Enum

 

 

Merchant Status

“ACTIVE” fixed value

Enum

 

 

Merchant Type

Merchant Type

Enum

 

 

Merchant WebDev Mode

Merchant WebDev Mode “CUSTOMER”

 Enum

 

 

nextMembershipDate

Date in format "2021-09-14"

LocalDate

 

 

nextStatementDate

Date in format "2021-06-03"

LocalDate

 

 

nextTurnoverfeeCalculationDate

Date in format "2021-07-21"

LocalDate

 

 

noOfDaysForPreAuth

Numeric value 1

Integer

 

 

noOfDaysPostTransaction

Numeric value 1

Integer

 

 

Offer code

Code value

String

 

 

Enroll start date

Start date format "2020-12-01"

LocalDate

 

 

Enroll end date

End date format "2020-12-31"

LocalDate

 

 

Payment Advise

Payment Advise "MERCHANT"

Enum

 

 

Payment Frequency

No of transaction days

Integer

 

 

Payment Level

Payment level "MERCHANT_LEVEL"

Enum

 

 

Posting Identifier

"AUTHORIZATION" fixed value

Enum

 

 

Real Time Settlement

Real time settlement indicator

Boolean (True/False)

 

 

Settlement Currency

Currency” INR”

 

 

 

Should Admin Fee Be Waived

Admin Fee waiver indicator

Boolean (True/False)

 

 

Should Chargeback Fee Be Waived

Chargeback Fee waiver indicator

Boolean (True/False)

 

 

Should Deinstallation Fee Be Waived

Deinstallation Fee waiver indicator

Boolean (True/False)

 

 

Should Dup Email Stmt FeeBeWaived

Duplicate email statement fee waiver indicator

Boolean (True/False)

 

 

Should Dup Stmt Fee Be Waived

Duplicate statement fee waiver indicator

Boolean (True/False)

 

 

Should Fallback Fee BeWaived

Fallback fee waiver indicator

Boolean (True/False)

 

 

shouldLateFeeBeWaived

Late fee waiver indicator

Boolean (True/False)

 

 

shouldOneTProcessFeeBeWaived

One TProcess fee waiver indicator

Boolean (True/False)

 

 

shouldPaymentAdviseEmailFeeBeWaived

PaymentAdviseEmailFee indicator

Boolean (True/False)

 

 

shouldPaymentAdviseFeeBeWaived

PaymentAdviseFee indicator

Boolean (True/False)

 

 

shouldPaymentBeOnHold

Payment on hold indicator

Boolean (True/False)

 

 

Should Rebate Be Waived

Rebate indicator

Boolean (True/False)

 

 

Should Replacement Fee Be Waived

Replacement fee waiver indicator

Boolean (True/False)

 

 

Should Setup Fee Be Waived

Setup fee indicator

Boolean (True/False)

 

 

shouldSupplyFeeBeWaived

Supply fee indicator

Boolean (True/False)

 

 

shouldTurnoverFeeBeWaived

Tuen over fee waiver indicator

Boolean (True/False)

 

 

shouldUserFeeBeWaived

User fee indicator

Boolean (True/False)

 

 

shouldmembershipFeeBeWaived

Membership fee indicator

Boolean (True/False)

 

 

shouldmiscFeeBeWaived

Misc fee indicator

Boolean (True/False)

 

 

shouldnonSuffFeeBeWaived

Non stuff fee waiver indicator

Boolean (True/False)

 

 

shouldserviceFeeBeWaived

Service fee indicator

Boolean (True/False)

 

 

shouldstatementFeeBeWaived

Statement fee indicator

Boolean (True/False)

 

 

Split Refund Needed

Split refund indicator

Boolean (True/False)

 

 

statement Frequency

Statement frequency” MONTHLY”

Enum

 

 

statement Level

statement Level “MERCHANT”

Enum

 

 

statement Mode

statement Mode “EMAIL”

Enum

 

 

statement Type

statement Type” SUMMARY”

Enum

 

 

Status Change Date

Sate in format "2020-09-07"

LocalDate

 

 

Ter AutoSettleSLa

 

 

 

 

Transaction Mode

AUTHORIZATION_AND_PURCHASE fixed value

Enum

 

 

Request Type

"QUERY" fixed value

String

 

 

Success

Success indicator

Boolean (True/False)

 

 

messageID: "/api/merchantDomain/allp/inq"
object: {id: "5f1ea9d48ffc613b544772aa", merchantModelKey: "testdoc"
}
id: "5f1ea9d48ffc613b544772aa"
merchantModelKey: "testdoc"
requestType: "QUERY"
 
object: {id: "5f1ea9d48ffc613b544772aa", merchantNumber: "454232321313454", merchantName: "Tokopedia",…
}
allianceOrgModelKey: "5f0fe276df3feb27396c9441"
certified: true
commProfileOverrideEndDate: "2020-08-04"
commProfileOverrideStartDate: "2020-07-31"
communicationProfile: "5e0ee588652c55473647b558"
cycleDate: "21"
id: "5f1ea9d48ffc613b544772aa"
isBannerActivated: true
isCardAcceptInternation: false
isChainPresent: false
isConvenienceFeeEnabled: false
isConvenienceFeeIncluded: false
isEmailActivated: true
isNotificationActivated: true
isOptedForDCC: false
isSMSActivated: true
isSplitPayment: false
isSurchargeFeeEnabled: false
isSurchargeFeeIncluded: false
isWhatsappActivated: true
lastStatementDate: "2021-05-03"
mcActivation: false
mccCode: "0742"
mccDescription: "Veternary Services"
merMarketDataIdentifier: "N"
merchantApplicationModelKey: "5f1e82e49d4dce6ba116a766"
merchantCommunicationList: [
    ,…
]
merchantCurrency: "INR"
merchantDebitAccount: {accountname: {firstName: "Sri", lastName: "Lakshmi"
    }, accountNumber: "173491834768",…
}
merchantDemographics: {id: "5f1ea9d48ffc613b544772a9", listOfMerchantNumbers: {
        1: "454232321313454"
    },…
}
merchantName: "Tokopedia"
merchantNumber: "454232321313454"
merchantPriority: "NON_PREMIER"
merchantProfile: "5e2571bfbdcb9c070c607073"
merchantSegment: "PLATINUM"
merchantStatus: "ACTIVE"
merchantType: "BOTH"
merchantWebDevMode: "CUSTOMER"
nextMembershipDate: "2021-09-14"
nextStatementDate: "2021-06-03"
nextTurnoverfeeCalculationDate: "2021-07-21"
noOfDaysForPreAuth: 1
noOfDaysPostTransaction: 1
offers: [
    {offerCode: "Offer1", enrollStartDate: "2020-11-30", enrollEndDate: "2020-12-14",…
    },…
]
paymentAdvise: "MERCHANT"
paymentFrequency: "TXN_nDAYS"
paymentLevel: "MERCHANT_LEVEL"
paymentWebsiteAddress: "https://banksit.touca"
postingIdentifier: "AUTHORIZATION"
realTimeSettlement: false
returnURL: "https://banksit.touca"
settlementCurrency: "INR"
shouldAdminFeeBeWaived: false
shouldChargebackFeeBeWaived: false
shouldDeInstallationFeeBeWaived: false
shouldDupEmailStmtFeeBeWaived: false
shouldDupStmtFeeBeWaived: false
shouldFallbackFeeBeWaived: false
shouldLateFeeBeWaived: false
shouldOneTProcessFeeBeWaived: false
shouldPaymentAdviseEmailFeeBeWaived: false
shouldPaymentAdviseFeeBeWaived: false
shouldPaymentBeOnHold: false
shouldRebateBeWaived: false
shouldReplacementFeeBeWaived: false
shouldSetupFeeBeWaived: false
shouldSupplyFeeBeWaived: false
shouldTurnoverFeeBeWaived: false
shouldUserFeeBeWaived: false
shouldmembershipFeeBeWaived: false
shouldmiscFeeBeWaived: false
shouldnonSuffFeeBeWaived: false
shouldserviceFeeBeWaived: false
shouldstatementFeeBeWaived: false
smId: "sri"
splitRefundNeeded: false
statementFrequency: "MONTHLY"
statementLevel: "MERCHANT"
statementMode: "EMAIL"
statementType: "SUMMARY"
statusChangeDate: "2020-08-26"
terAutoSettleSLa: "06:00"
transactionMode: "AUTHORIZATION_AND_PURCHASE"
requestType: "QUERY"
success: true
 
Error Description: - Record Not Found.
Onboarding Login Request

API URL

api/auth/onboarding/login request

HTTP Method

POST

REQ/RES TYPE

Application/JSON

Field name Description Data type Mandatory Length

Message ID

Message ID for validate OTP request

String

 

 

Object

Request Content

-

 

 

Application number

Specifies the application number

Number

Y

 

Login credentials

“APPLICATION NUMBER” fixed value

String

Y

 

Login hash

Login hash code

 

 

 

Request type

“UPDATE” fixed value

string

 

 

Onboarding Login Response
Field name Description Data type Mandatory Length

Object

Response content

-

 

 

Id

ID number

 

 

 

Application number

Specifies the application number

 

 

 

Application status

“IN-PROGRESS” (fixed value)

String

 

 

Acquired by comp

Acquired by company indicator

Boolean (True/False)

 

 

Assigned to model key

It specifies the assigned system user for the application.

String

 

 

Applicant email ID

It stores the email Id of the applicant.

String

 

 

First name

Specifies the merchant’s first name.

String

Y

 

Last name

Specifies the merchant’s last name.

String

 

 

Application number

Specifies the application number

 

 

 

Application status

“IN-PROGRESS” (fixed value)

String

 

 

Ben action

 

 

 

 

Credit Bureau Score Update Date

Specifies the Credit score calculated date.

Local date

 

 

Credit Bureau Score

Specifies the Credit bureau score of each merchant.

Integer

 

 

Date Created

represents the date on which the application has started

Local date

 

 

Establishment Details

Represents all the establishment details of the merchant.

Establishment

Y

 

Existing Account

Existing account indicator

Boolean (True/False)

 

 

First Owner List

Represents all the details of the First Owner.

Owner details

Y

 

Id

Request ID

String

 

 

Input Source

Represents the exact source, with which the Merchant is trying to connect.

Values: BANK_APP, BANK_INTERNAL_APP, BANK_WEB, DSA, MERCHANT_APP, SELF_PORTAL, SM.

Enum

 

 

Input source ID

Represents input source name

String

 

 

Ip address

Saves the IP address from where the Merchant is trying to board. Format: 127.0.1.1 String    

Is Card Accept International

International card acceptance Indicator Boolean (True/False)    

Is International Delivery

International Delivery indicator Boolean (True/False)    

Is Opted for DCC

DCC indicator Boolean (True/False)    

Is Report Mandatory

Report Mandatory indicator Boolean (True/False)    

Is Split Payment

Split Payment indicator Boolean (True/False)    

Is Stp Qualified

Stp qualified indicator Boolean (True/False)    

Is User Reassigned

User Reassigned indicator Boolean (True/False)    

Login hash

Represents the login hash code      
Mc Activation Mc Activation indicator Boolean (True/False)    
Mcc For Business Specifies the business type String Y  

Merchant Type

Represents the type of the Merchant

Values: ONLINE, RETAIL, BOTH.
Enum    

Country code

 The Country code of the merchant.

String

 

 

Number

Specifies the merchant mobile number.

String

 

 

Second Owner List

Represents all the details of the Second Owner.

String

 

 

Smid

 

 

 

 

Split refund needed

Split refund Indicator

Boolean (True/False)

 

 

Statement Type

It specifies the statement type used by the Merchant.

Values: DETAILED, SUMMARY, NONE.

Enum

 

 

UW Merchant priority

Specifies the under-writer merchant priority

String

 

 

Success

Success indicator

Boolean (True/False)

 

 

Token

Token ID

 

 

 

messageID: "/api/auth/onBoarding/login"
object: {loginCredentials: "APPLICATION_NUMBER",…
}
applicationNumber: "413191026946545088"
loginCredentials: "APPLICATION_NUMBER"
loginHash: "6c3f2992e37335c728f2c2359d94e782d99b3531fcc36d7a33c2e7afe69b3fb8a0e9a4873d437dcdc02bcb82a89376fe06240fd12da9e5fac7dee1f9ae97942a"
requestType: "UPDATE"
 
object: {id: "60ebdb50c0b9e04650103681", applicationNumber: "201260644743902496", applicationStatus: "SAVED",…
}
acquiredByComp: false
allianceOrgModelKey: "6092447b225dfd4f72dd738f"
applicantEmailId: "[email protected]"
applicantName: {firstName: "Test", lastName: "app"
}
firstName: "Test"
lastName: "app"
applicationNumber: "201260644743902496"
applicationStatus: "SAVED"
benAction: "0"
creditBereauScoreUpdateDate: "2021-07-12"
creditBureauScore: 701
dateCreated: "2021-07-12"
establishmentDetails: {legalName: "Check",…
}
existingAccount: false
firstOwnerList: {ownerName: {}, ownerDBAName: {}, currentAddress: {region: "AP"
    }, mobileNumber: {},…
}
id: "60ebdb50c0b9e04650103681"
inputSource: "BANK_WEB"
inputSourceID: "krishhna"
ipaddress: "127.0.1.1"
isCardAcceptInternational: false
isInternationalDelivery: false
isOptedForDCC: false
isReportMandatory: false
isSplitPayment: false
isStpQualified: false
isUserReassigned: false
loginHash: "cfe1e9a26ee012eb23a67e19cb6c49fbdfb83d8abf943229b34f4f6eeac8024bd22a4138144e37a64e3349fb5f7a373e7c3c598de478da92262e6bbfd510a1ab"
mcActivation: false
merchantType: "RETAIL"
mobileNumber: {countryCode: "+91", number: "9000000000"
}
secondOwnerList: {ownerName: {}, ownerDBAName: {}, currentAddress: {region: "AP"
    }, mobileNumber: {},…
}
smid: "prasanna"
splitRefundNeeded: false
statementType: "SUMMARY"
uwMerchantPriority: "NON_PREMIER"
success: true
token: "eyJhbGciOiJIUzI1NiJ9.eyJzdWIiOiJTRUxGQVBQQDIwMTI2MDY0NDc0MzkwMjQ5NiIsImlhdCI6MTYyNjA3MDMxOSwiZXhwIjoxNjI2MDc3NTE5fQ.JeWp9355sARcw8fg0ZlgFbKuypTJg6DS3g2xivmYc60"
 
Error Description: - Object received as null. So, ignoring further process.
Service Request creation

This API can be used to raise a Service Request for a merchant under alliance Partner/aggregator. Response would contain the SR number assigned to the request.

API URL

api/operatingtime/allp/cre

HTTP Method

POST

REQ/RES TYPE

Application/JSON

Operating Times SR create request
Field name Description Data type Mandatory Length

 Message ID

 Message ID for operating time creation

String

 

 

 Object

 Request content

 

 

 

 Address

 Complete address of the merchant

String

 

 

Description Values

"OPERATION_START_TIME" fixed value

String

 

 

ID

Request ID

String

 

 

Mail Attachments

Mail attachments

TUpload

 

 

Merchant Attachments

Attachments

Tupload

 

 

Merchant Email Id

Email ID

String

 

 

Merchant Model Key

Model key value

String

 

 

Merchant Name

Merchant name

String

 

 

Merchant Number

Merchant number

String

 

 

Normal Attachments

 

TUpload

 

 

Primary Contact

Contant number of merchants

String

 

 

Raised By

Alliance agent name

String

 

 

Secondary Contact

Secondary Contact number

String

 

 

Service Request Sub Type

SR sub type "MERCHANT_LEVEL"

String

Y

 

Service Request Type

SR type "OPERATING_TIMES"

Enum

Y

 

Tid List

Terminal number

List

 

 

Request Type

"CREATE" fixed value

String

 

 

Operating time Creation Response
Field name Description Data type Mandatory Length

 Object

 Response content

 

 

 

 Address

 Complete address of the merchant

String

 

 

All pmodel key

 Alliance agent model key

String

 

 

Assigned To

SR request Assigned person name

String

 

 

Assigned User Group

 User group name

String

 

 

Checker ID

Checker ID name

String

 

 

Description Values

"OPERATION_START_TIME" fixed value

String

 

 

Expected Closure Date

Date in format "2021-05-26"

LocalDate

 

 

Id

Service request ID

String

 

 

Is Otp Verified

OTP indicator

Boolean (True/False)

 

 

Is Sla Cross

SLA indicator

Boolean (True/False)

 

 

Is User Reassigned

User reassigned indicator

Boolean (True/False)

 

 

Merchant Email Id

Email ID

String

 

 

Merchant Model Key

Model key value

String

 

 

Merchant Name

Merchant Name

String

 

 

Merchant Number

Merchant Number

String

 

 

Primary Contact

Merchant primary contact number

String

 

 

priority

Priority

Enum

 

 

Raised By

Alliance agent name

String

 

 

Scheduled Date

Date in format "2021-05-26"

LocalDate

 

 

Secondary Contact

Merchant secondary contact number

String

 

 

Service Request Date Time

Date and time format "2021-05-16T20:43:39.088068"

LocalDateTime

 

 

Service Request Sub Type

SR sub type "MERCHANT_LEVEL"

String

Y

 

Service Request Type

SR type "OPERATING_TIMES"

Enum

Y

 

source

Source “WEB”

Enum

 

 

Sr Category

Sr Category "EXTERNAL"

Enum

 

 

Sr Status

SR status "OPEN"

Enum

 

 

Request Type

“CREATE” fixed value

 

 

 

success

Success indicator

String

 

 

messageID: "/api/operatingtime/allp/cre"
object: {
    ,…
}
address: {lines: "NCS Road", city: "Vizianagaram", state: "ANDHRA PRADESH", country: "India", pincode: "535002",…
}
descriptionValues: [
    {description: "OPERATION_START_TIME", toValue: "10:00"
    },…
]
id: "SRN880666056054"
mailAttachments: []
merchantAttachments: []
merchantEmailId: "[email protected]"
merchantModelKey: "5f1ea9d48ffc613b544772aa"
merchantName: "Tokopedia"
merchantNumber: "454232321313454"
normalAttachments: []
primaryContact: {number: "6787665568"
}
raisedBy: "testdoc"
secondaryContact: {countryCode: "91", number: "8145214512"
}
serviceRequestSubType: "MERCHANT_LEVEL"
serviceRequestType: "OPERATING_TIMES"
tidList: []
requestType: "CREATE"
 
object: {id: "SRN880666056054", serviceRequestType: "OPERATING_TIMES", serviceRequestSubType: "MERCHANT_LEVEL",…
}
address: {lines: "NCS Road", city: "Vizianagaram", state: "ANDHRA PRADESH", country: "India", pincode: "535002",…
}
allPModelKey: "testdoc"
assignedTo: "prasanna"
assignedUserGroup: "5ec32e8405a2b8121f2dd623"
checkerId: "sri"
descriptionValues: [
    {description: "OPERATION_START_TIME", toValue: "10:00"
    },…
]
expectedClosureDate: "2021-05-26"
id: "SRN880666056054"
isOtpVerified: true
isSlaCross: false
isUserReassigned: false
merchantEmailId: "[email protected]"
merchantModelKey: "5f1ea9d48ffc613b544772aa"
merchantName: "Tokopedia"
merchantNumber: "454232321313454"
primaryContact: {number: "6787665568"
}
priority: "LOW"
raisedBy: "testdoc"
scheduledDate: "2021-05-26"
secondaryContact: {countryCode: "91", number: "8145214512"
}
serviceRequestDateTime: "2021-05-16T20:43:39.088068"
serviceRequestSubType: "MERCHANT_LEVEL"
serviceRequestType: "OPERATING_TIMES"
source: "WEB"
srCategory: "EXTERNAL"
srStatus: "OPEN"
requestType: "CREATE"
success: true
 
Operating time Inquiry Request

This API can be used to inquire a Service Request that is raised for a merchant under alliance Partner/aggregator using the unique SR number assigned to the request. Response would contain the status of the SR.

API URL

api/operatingtime/allp/inq

HTTP Method

POST

REQ/RES TYPE

Application/JSON

Field name Description Data type Mandatory Length

Message ID

Message ID for operating time inquiry

 String

 

 

Object

Request content

-

 

 

Id

Request ID

String

Y

 

Merchant Model Key

Model key value

String

 

 

Request Type

"QUERY" fixed value

 

 

 

Operating time Inquiry Response
Field name Description Data type Mandatory Length

Field name

Description

Data type

Mandatory

Length

 Object

 Response content

 

 

 

 Address

 Complete address of the merchant

String

 

 

All pmodel key

 Alliance agent model key

String

 

 

Assigned To

SR request Assigned person name

String

 

 

Assigned User Group

 User group name

String

 

 

Checker ID

Checker ID name

String

 

 

Description Values

"OPERATION_START_TIME" fixed value

String

 

 

Expected Closure Date

Date in format "2021-05-26"

LocalDate

 

 

Id

Service request ID

String

 

 

Is Otp Verified

OTP indicator

Boolean (True/False)

 

 

Is Sla Cross

SLA indicator

Boolean (True/False)

 

 

Is User Reassigned

User reassigned indicator

Boolean (True/False)

 

 

Merchant Email Id

Email ID

String

 

 

Merchant Model Key

Model key value

String

 

 

Merchant Name

Merchant Name

String

 

 

Merchant Number

Merchant Number

String

 

 

Primary Contact

Merchant primary contact number

String

 

 

priority

Priority

Enum

 

 

Raised By

Alliance agent name

String

 

 

Scheduled Date

Date in format "2021-05-26"

LocalDate

 

 

Secondary Contact

Merchant secondary contact number

String

 

 

Service Request Date Time

Date and time format "2021-05-16T20:43:39.088068"

LocalDateTime

 

 

Service Request Sub Type

SR sub type "MERCHANT_LEVEL"

String

Y

 

Service Request Type

SR type "OPERATING_TIMES"

Enum

Y

 

source

Source “WEB”

Enum

 

 

Sr Category

Sr Category "EXTERNAL"

Enum

 

 

Sr Status

SR status "OPEN"

Enum

 

 

Request Type

“CREATE” fixed value

 

 

 

success

Success indicator

String

 

 

messageID: "/api/operatingtime/allp/inq"
object: {id: "SRN880666056054", merchantModelKey: "testdoc"
}
id: "SRN880666056054"
merchantModelKey: "testdoc"
requestType: "QUERY"
 
object: {id: "SRN880666056054", serviceRequestType: "OPERATING_TIMES", serviceRequestSubType: "MERCHANT_LEVEL",…
}
address: {lines: "NCS Road", city: "Vizianagaram", state: "ANDHRA PRADESH", country: "India", pincode: "535002",…
}
allPModelKey: "testdoc"
assignedTo: "prasanna"
assignedUserGroup: "5ec32e8405a2b8121f2dd623"
checkerId: "sri"
descriptionValues: [
    {description: "OPERATION_START_TIME", toValue: "10:00"
    },…
]
expectedClosureDate: "2021-05-26"
id: "SRN880666056054"
isOtpVerified: true
isSlaCross: false
isUserReassigned: false
merchantEmailId: "[email protected]"
merchantModelKey: "5f1ea9d48ffc613b544772aa"
merchantName: "Tokopedia"
merchantNumber: "454232321313454"
primaryContact: {number: "6787665568"
}
priority: "LOW"
raisedBy: "testdoc"
scheduledDate: "2021-05-26"
secondaryContact: {countryCode: "91", number: "8145214512"
}
serviceRequestDateTime: "2021-05-16T20:43:39.088"
serviceRequestSubType: "MERCHANT_LEVEL"
serviceRequestType: "OPERATING_TIMES"
source: "WEB"
srCategory: "EXTERNAL"
srStatus: "OPEN"
requestType: "QUERY"
success: true
Manual Transaction Posting Request

This API can be used to raise a transaction to be posted to the merchant.Response would contain the status of the transaction i.e. if the transaction was successfully posted to the merchant or not.

API URL

api/transaction/manualtxnPosting

HTTP Method

POST

REQ/RES TYPE

Application/JSON

Field name Description Data type Mandatory Length

Message ID

Message ID for operating time inquiry

String

 

 

Object

Request content

-

 

 

Terminal Number

Terminal ID

String

Y

 

Merchant Number

Merchant Number

String

Y

 

Merchant Name

Merchant Name

String

Y

 

Additional Amount

Amount “INR”

BigDecimal

 

 

Card Bin

Card bin number

String

 

 

currency

“INR”

Currency

 

 

Incoming Amt

Amount value

BigDecimal

 

 

last4Digit

Last 4 digits of original authorized request

String

 

 

Mcc Code

4-digit code

String

 

 

Merchant City

Merchant city name

String

 

 

Merchant Country

Country name

String

 

 

Merchant Pin code

Pin code number

String

 

 

Merchant State

Merchant state name

String

 

 

Pos Entry Mode

Pos Entry Mode “ALL”

Enum

 

 

Posting Type

Posting Type “PURCHASE”

Enum

Y

 

Terminal Number

Terminal ID

String

 

 

Transaction Date Time

Date and time format "2021-05-17T15:22:11.392549"

LocalDateTime

 

 

Request Type

"CREATE" fixed value

 

 

 

Manual Transaction Posting Response
Field name Description Data type Mandatory Length

object

Response content

 

 

 

Tran Code

Tran Code “PURCHASE”

Enum

 

 

Card Bin

BIN of the card used

String

 

 

Card Origination

Card Origination indicator

Boolean (True/False)

 

 

Card Type

Card Type "CREDIT"

Enum

 

 

Dispute Amount

Amount value

BigDecimal

 

 

Dispute Recovery

Dispute Recovery "INITIAL_DISPUTE"

Enum

 

 

Do NotPay

Do NotPay indicator

Boolean (True/False)

 

 

Id

Request ID

String

 

 

Incoming Additional Amt

Amount value

BigDecimal

 

 

code

INR

Currency

 

 

value

Value

BigDecimal

 

 

Incoming Tran Amt

Amount value

BigDecimal

 

 

Is Markup Recovery Needed

Markup indicator

Boolean (True/False)

 

 

Is Mdr Recovery Needed

MDR recovery indicator

Boolean (True/False)

 

 

Is Tax Recovery Needed

Tax Recovery indicator

Boolean (True/False)

 

 

last4DigitCardNum

Last 4 digits of the card used

String

 

 

Mcc Code

4-digit code

String

 

 

Merchant City

City name

String

 

 

Merchant Country

Country name

String

 

 

Merchant Currency

Currency “INR”

Currency

 

 

Merchant Id

Merchant Id

String

 

 

Merchant Name

Merchant name

String

 

 

Merchant Number

Merchant Number ID

String

 

 

Merchant Pin code

6digit pin code value

String

 

 

Merchant Profile Name

Profile name

String

 

 

Merchant Region

Region name

String

 

 

Merchant State

Merchant state name

String

 

 

Merchant Status

"ACTIVE" fixed value

Enum

 

 

Model Name

Model Name "SETTLEMENT"

Enum

 

 

Nature Of Buss

"Agricultural Services"

Enum

 

 

Network

Card Scheme name

Enum

 

 

Payment Date Type

"TRANSACTION_DATE" fixed value

Enum

 

 

Pos Entry Mode

Pos Entry Mode “ALL”

Enum

 

 

IS success

Success indicator

Boolean (True/False)

 

 

Calculated MDR amt

Amount value

BigDecimal

 

 

Remark

Remark message

String

 

 

Split Payment List

Split payment account details of merchant

List

 

 

Terminal Number

Terminal ID

String

 

 

Trace Flag

Flag indicator

Boolean (True/False)

 

 

Tran Code

Tran Code “PURCHASE”

Enum

 

 

Transaction Currency

Transaction Currency “INR”

Currency

 

 

Transaction Id

Transaction code

String

 

 

Transaction Ref Num

Transaction Ref ID

String

 

 

Transaction Time

Time in format "2021-05-17T15:22:11.392549"

LocalDateTime

 

 

success

Success indicator

Boolean (True/False)

 

 

messageID: "/api/transaction/manualtxnPosting"
object: {terminalNumber: "10018837", merchantNumber: "107183000077271", merchantName: "RBL APP5",…
}
additionalAmount: {code: "INR"
}
cardBin: "652106"
currency: "INR"
incomingAmt: {value: "50000.00", code: "INR"
}
last4Digit: 5412
mccCode: "8062"
merchantCity: "Krishna"
merchantCountry: "India"
merchantName: "RBL APP5"
merchantNumber: "107183000077271"
merchantPincode: "520015"
merchantState: "ANDHRA PRADESH"
posEntryMode: "ALL"
postingType: "PURCHASE"
terminalNumber: "10018837"
transactionDateTime: "2021-05-17T15:22:11.392549"
requestType: "CREATE"
 
object: {id: "60a23d80f2d9cb0069683fa8", tranCode: "PURCHASE", network: "RUPAY", posEntryMode: "ALL",…
}
cardBin: "652106"
cardOrigination: false
cardType: "CREDIT"
disputeAmount: {value: 0, code: "INR"
}
disputeRecovery: "INITIAL_DISPUTE"
doNotPay: false
id: "60a23d80f2d9cb0069683fa8"
incomingAdditionalAmt: {value: 0, code: "INR"
}
code: "INR"
value: 0
incomingTranAmt: {value: 50000, code: "INR"
}
code: "INR"
value: 50000
isMarkupRecoveryNeeded: false
isMdrRecoveryNeeded: false
isTaxRecoveryNeeded: false
last4DigitCardNum: "5412"
mccCode: "8062"
merchantCity: "Krishna"
merchantCountry: "India"
merchantCurrency: "INR"
merchantId: "6087e9c81d76546b1d6059e3"
merchantName: "RBL APP5"
merchantNumber: "107183000077271"
merchantPincode: "520015"
merchantProfileName: "RBL Profile1"
merchantRegion: "AP"
merchantState: "ANDHRA PRADESH"
merchantStatus: "ACTIVE"
modelName: "SETTLEMENT"
natureOfBuss: "AgriculturalServices"
network: "RUPAY"
paymentDateType: "TRANSACTION_DATE"
posEntryMode: "ALL"
postingData: {isSuccess: true, calculatedMdrAmt: {value: 10, code: "INR"
    },…
}
remark: "Interchange table not found"
splitPaymentList: [
    {accountname: {firstName: "BOORA PHANI", lastName: "KUMAR"
        }, accountNumber: "142201528069",…
    }
]
terminalNumber: "10018837"
traceFlag: false
tranCode: "PURCHASE"
transactionCurrency: "INR"
transactionId: "0"
transactionRefNum: "113715251214"
transactionTime: "2021-05-17T15:22:11.392549"
success: true
 
Error Description:- 
1>Duplicate RRN found on same TerminalNumber
2>Merchant Status is not Active
3>Risk Profile is not Set in Merchant Profile
4>Merchant Profile not found
5>Merchant Profile not found