POSTFetch Suggested Fields API
Use Case
This API is used to fetch previously created fields during form creation. Use this to create forms faster
Request Attributes
Head
| Attribute | Description |
|---|---|
timestamp string(15) optional | EPOCH timestamp of the time at which request is being sent. |
clientId string(3) optional | Paytm use the merchant key on the basis of clientId parameter value. It requires only if the merchant has more than one key. Example: C11 |
version string(4) optional | Version of the API. Example: v2 |
channelId string(3) optional | The parameter value identifies the Channel for which API call is initiated. Possible values:
WEB
,
For websites, the value to be passed should be "WEB"
WAP
For Mobile websites/App, the value to be passed should be "WAP"
|
tokenType string mandatory | This parameter identifies whether the API works on checksum authentication. The value to be sent in tokenType is 'AES' for this API. |
signature string(108) mandatory | Paytm validates the request and ensures that parameters are not tempered by verifying the signature in the request. For creating the checksum (signature) refer to the steps given in Checksum Logic. |
Body
| Attribute | Description |
|---|---|
mid string(20) 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 |
templateId string optional | Template ID unique to a form template |
Response Attributes
Head
| Attribute | Description |
|---|---|
timestamp string(15) | EPOCH timestamp of the time at which response is being sent. |
clientId string(3) | Paytm use the merchant key on the basis of clientId parameter value. It requires only if the merchant has more than one key. Example: C11 |
version string(2) | Version of the API passed in the request. |
channelId string(3) | The parameter value identifies the Channel for which API call is initiated. Possible values:
WEB
,
For websites, the value to be passed should be "WEB"
WAP
For Mobile websites/App, the value to be passed should be "WAP"
|
tokenType string | This parameter identifies whether the API works on checksum authentication. The value to be sent in tokenType is 'AES' for this API. |
signature string(108) | Paytm validates the request and ensures that parameters are not tempered by verifying the signature in the request. For creating the checksum (signature) refer to the steps given in Checksum Logic. |
Body
| Attribute | Description | ||||||||||||||||||||||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
resultInfo object | This parameter gives the information about the result of the API response | ||||||||||||||||||||||||||||||||||||||||||||
ResultInfo +
| |||||||||||||||||||||||||||||||||||||||||||||
mandatoryFields object | Mandatory fields of template | ||||||||||||||||||||||||||||||||||||||||||||
Fields +
| |||||||||||||||||||||||||||||||||||||||||||||
fields object | Optional fields of template | ||||||||||||||||||||||||||||||||||||||||||||
Fields +
| |||||||||||||||||||||||||||||||||||||||||||||
Response Codes & Messages
| resultCode | resultStatus | resultMessage |
|---|---|---|
| LF_001 | SUCCESS | Success |
| LF_002 | FAILED | Invalid Request |
| 501 | FAILED | Internal Server Error |
| 502 | FAILED | Unknown Error Occurred |
| 5004 | FAILED | empty merchant Id. |
| 5028 | FAILED | Checksum provided is invalid. |
| 5029 | FAILED | request body cannot be empty |
| 5030 | FAILED | request head cannot be empty |
curl -X POST 'https://securegw-stage.paytm.in/link/form/fetchSuggestedFields' \
--header 'Content-Type: application/json' \
--data '{"body":{"mid":"{mid}"},"head":{"tokenType":"AES","signature":"{signature}"}}'
