POSTIMEI Validation API

Use Case

This API is to be called post transaction for the orders where Brand offers are successfully applied and brands mandates to perform IMEI/Sr. Number validation of the product being shipped to the consumer
Merchant needs to send the product details (Brand ID, Category ID, SKU code, IMEI/Sr. No.) and also Brand issued identifier for the merchant (Dealer code, State code)
For Blocking an IMEI/Sr. No. at Brand’s end, Merchant needs to call this API with Action: BLOCK
For the orders where Refund has been initiated, merchant needs to Unblock the IMEI/Sr. No. at Brand’s end. Merchant needs to call this API with Action: UNBLOCK
It is desired that the merchant calls this API within 1-2 days of the order being successful for the action "BLOCK"

Note: This API will soon be supported on staging.

Request Attributes

Content Type : JSON

Head

Attribute	Description
clientId string mandatory	Paytm use the merchant key on the basis of clientId parameter value. It requires only if the merchant has more than one key.
version string mandatory	Version of the API passed in the request. Example: v1
requestTimestamp string mandatory	EPOCH timestamp of the time at which request is being sent. Example: 1588402269
channelId string mandatory	The parameter value identifies the Channel for which API call is initiated. Possible values: WEB , WAP
signature string mandatory	You should validate the parameter values by verifying the signature comes in the response. It ensures that parameter values not tempered. Signature string can be verified by using Paytm checksum library.

Body

Attribute	Description
mid string mandatory	Paytm provides MID as a unique identifier to each merchant. For your staging MID, click here. You get the production MID post the account activation. Example: INTEGR7769XXXXXX9383
orderId string mandatory	The Unique reference ID of the Order. It is alphanumeric and max length is 50 characters. Example: OREDRID_98765
action string optional	Action required on the product Example: BLOCK/UNBLOCK Note: By default its value will be BLOCK (if we don't get it in request)
skuCode string mandatory	SKU code of the product Example: iphone1234
brandId string mandatory	Brand Id of the product Example: Apple1234
categoryId string optional	Category Id of the product Example: mobile1234
imei / serialNo string mandatory	imei / serial no of the product Example: 123412341234123
stateCode string optional	stateCode of the dealer's store Example: Oppo1234
dealerCode string optional	Dealer identification issued by Brand Example: Vivo9876

Response Attributes

Content Type : JSON

Body

Attribute

Description

resultInfo

object

This parameter gives the information about the result of the API response

Resultinfo

Attribute	Description
resultStatus string	Result Status Example: S
resultCode string	Result code Example: SUCCESS
resultCodeId string	Result code ID Example: 001
resultMsg string	Result message Example: Success

mid

string

Paytm provides MID as a unique identifier to each merchant. For your staging MID, click here. You get the production MID post the account activation.

Example: INTEGR7769XXXXXX9383

orderId

string

The Unique reference ID of the Order. It is alphanumeric and max length is 50 characters.

Example: OREDRID_98765

Response Codes & Messages

resultCode	resultStatus	resultMsg
001	SUCCESS	Success
010	SYSTEM_ERROR	System Error
011	SYSTEM_ERROR	Internal System Error
009	FAIL	Fail

⇾

Staging

Production

REQUEST

RESPONSE

CURL

JAVA

NODE

PHP

PYTHON

DOTNET

curl --location 'https://securegw.paytm.in/theia/api/v1/imei?mid=<YOUR MID>' \
--header 'Content-Type: application/json' \
--data '{"head": {"clientId": "C11", "version": "v1", "requestTimestamp": "Time", "channelId": "WEB",
"signature": "CHECKSUM"},"body": {"mid": "Your_MID_Here","action": "BLOCK", "orderId": "PARCEL790206","skuCode": "123456", "brandId": "124198","stateCode": "Abcd1234","dealerCode": "xyz987","categoryId": "667811","imei": "12345678988"}}