m2pfintech
API LibraryCollect Block Management

Block or Unblock VPA for Collect Requests

Blocks or unblocks a specific VPA from sending collect requests to the user. When a VPA is blocked, any collect requests from that VPA will be automatically rejected. Supported actions are BLOCK and UNBLOCK.

POST
/upi/v1/wrapper/transaction/collectRequestBlock

Request Body

application/json

deviceInfo*

Device and SIM information required for UPI API authentication and tracking

channelCode*string
seqNo*string
vpaId*string

VPA to block or unblock from sending collect requests

action*string

Block or unblock action

Value in"BLOCK" | "UNBLOCK"

Response Body

application/json

curl -X POST "https://sandbox-upi-api.m2pfintech.com/upi/v1/wrapper/transaction/collectRequestBlock" \  -H "Content-Type: application/json" \  -d '{    "deviceInfo": {      "deviceId": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",      "simId": "8991101200003204510",      "deviceType": "MOB",      "os": "Android",      "telecom": "Airtel",      "geoCode": "13.0827,80.2707",      "appId": "v2.0",      "ipAddress": "192.168.1.50",      "location": "Mumbai",      "mobile": "919876501234"    },    "channelCode": "HDFC0001234",    "seqNo": "605",    "vpaId": "spammer@bank",    "action": "BLOCK"  }'

{
  "status": "SUCCESS",
  "exception": null,
  "seqNo": "605",
  "message": "VPA blocked successfully",
  "result": "TRUE"
}

Pending Collect Request Count POST

Returns the count of pending collect requests for the user. Use this to show a badge or notification count for pending collect requests that need the users attention (approve or decline).

OTP Request for PIN Setup POST

Initiates an OTP request to the bank for UPI PIN setup or change. The OTP is delivered to the users registered mobile number by the bank. This is an asynchronous API - check the OTP delivery status using otpResp. The OTP and card details are then used by the Common Library SDK to encrypt and set the UPI PIN.