search

POSTDisable VAN API

Use Case

This API is used to enable/disable VAN's. The status of the VAN account may have two possible values:

  • Active - If a VAN is active, money transferred by the customer will be accepted
  • Inactive - If VAN is Inactive, money transferred by the customer will be reversed

Request Attributes

Content Type : JSON

Head

AttributeDescription
requestTimestamp
string(15)
optional

EPOCH timestamp of the time at which request is being sent.
Example: 1588402269

tokenType
string(10)
mandatory

This parameter identifies if the API works on checksum authentication.

Possible Values: CHECKSUM,JWT

token
string
mandatory
  • For tokenType JWT, use JWT token.
  • For tokenType CHECKSUM, the value to be sent should be the checksum string created using the Paytm checksum library. Authorization string corresponding to the tokenType used.

Example: 16Xm7DXbvNqhaLw+HMj4XB6XTQKCoM=

channelId
string(6)
optional

The parameter value identifies the Channel for which API call is initiated.

Possible Values: WEB/WAP/SYSTEM

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
optional

Version of the API.

Example: v1

Body

AttributeDescription
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

requestId
string(20)
mandatory

Unique request id

vanInfo
object
mandatory

Van info consists of the Virtual Account Number ( VAN) and its status. At least one VAN and max 10 can be activated or inactivated in a single go.

VanInfo
+
AttributeDescription
van
string(16)
mandatory

Virtual Account Number. This is a 16 alphanumeric account number which will be given to the end customer to initiate a bank transfer.

active
boolean
mandatory

Status of the VAN account. It has two possible values:

  • Active - If a VAN is active, money transferred by the customer will be accepted
  • Inactive - If VAN is Inactive, money transferred by the customer will be reversed

Response Attributes

Content Type : JSON

Head

AttributeDescription
responseTimestamp
string(15)

EPOCH timestamp of the time at which response is being sent.
Example: 1588402269

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

signature
string

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

AttributeDescription
resultInfo
object

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

ResultInfo
+
AttributeDescription
resultCode
string

This is the resultCode corresponding to a particular message and is returned to the merchant. It's maximum length is 64. The different result codes corresponding to this API are mentioned below.

resultStatus
string

This parameter indicates the status of API call.

Possible values:
S
For Success
,
F
For Failure
resultMsg
string

This parameter is the result message which contains information about the result. The different result messages corresponding to this API are mentioned below in section " Response Codes and Messages".

vanInfo
object

Van info consists of Virtual Account Number (VAN) and its status. At least one VAN and max 10 can be activated or inactivated in a single go.

VanInfo
+
AttributeDescription
van
string(10)

Virtual Account Number. This is a 16 alphanumeric account number which will be given to the end customer to initiate a bank transfer.

vanStatus
string

It has two possible values:

  • Active - If a VAN is active, money transferred by the customer will be accepted
  • Inactive - If VAN is Inactive, money transferred by the customer will be reversed
responseStatus
string

Possible Values: SUCCESS, FAILED

errorCode
string(3)

Provided in case of errors

errorMessage
string

Provided in case of errors

Response Codes & Messages

resultCoderesultStatusresultMessage
200 SUCCESS Success
302 FAILED Request Validation Failure
401 FAILED Invalid Request
404 FAILED Data Not Found
502 FAILED Unknown Error Occurred
Staging
Production
https://securegw-stage.paytm.in/vanproxy/api/v1/van/update?mid={mid}copy icon
REQUEST
RESPONSE
CURL
JAVA
NODE
PHP
PYTHON
DOTNET
curl -X POST 'https://securegw-stage.paytm.in/vanproxy/api/v1/van/update?mid=INTEGR77698636129383' \
--header 'Content-Type: application/json' \
--data '{"body":{"requestId":"1607519443","mid":"INTEGR77698636129383","vanInfo":[{"van":"PYI3831606838802","active":"true"}]},"head":{"clientId":"C11","version":"v1","requestTimestamp":"1607519443","channelId":"WEB","tokenType":"CHECKSUM","token":"zcJRBkc1YRpWrc91c+cGEzw/AwghrDd+yvxlRMb658pwHRUknFfMRZbHP2OK1obTNaJqPfSnF7ggfoDz8qATm1KkdW6QD7w6I4CSJ7L1ZQA="}}'

 

copy icon