| Time | Status | User Agent | |
|---|---|---|---|
Retrieving recent requests… | |||
Check the outlet’s UPI ATM KYC status and obtain the reference needed for capture.
POST https://pay2new.in/apis/upiAtm/v1/biometricKycStatus
Headers
| Header | Required | Description |
|---|---|---|
secret | Yes | Your Pay2New API secret. |
outletId | Yes | Pay2New outlet/customer ID returned after successful onboarding; do not send the provider outlet ID. |
Accept | No | Request a JSON response. |
Requests require an active partner account, approved KYC, active wallet and API access, an allowlisted source IP, and the relevant service enabled.
No request body is required.
Usage notes
- No request body is required.
- KYC completion is indicated by data.action NO-ACTION-REQUIRED and data.status APPROVED. Otherwise, follow the action and capture details in the response.
Response
Application status is returned in the JSON status field. A successful HTTP response alone does not confirm a successful operation.
| Field | Description |
|---|---|
status | integer: application status, not HTTP status |
message | string |
data | Object with customer_aadhaar_number, status, pidOptionWadh, referenceKey, action. |
order_id | null |
Provider-dependent fields may be absent or null. status: 2 indicates a failure. For transaction endpoints, status: 3 indicates pending or uncertain processing and requires status confirmation.
Illustrative response:
{
"status": 1,
"message": "Success",
"data": {
"customer_aadhaar_number": "XXXXXXXX9999",
"status": "APPROVED",
"pidOptionWadh": "",
"referenceKey": "",
"action": "NO-ACTION-REQUIRED"
},
"order_id": null
}
Errors
Validation errors can include an errors object keyed by field name. Authentication, outlet, service and other processing errors can return only status and message. Errors are application-level responses; do not rely on an HTTP 400 status.
{
"status": 2,
"message": "Secret Header not found!"
}