UPI Setu

VPA verification

API Playground

These statuses are relevant for the VPA verification done under the UPI payments collect request product.

Details for customer VPA verification statuses

  • customer_vpa.valid Provided VPA is valid and associated with a bank account

  • customer_vpa.invalid Provided VPA is invalid and account details could not be fetched

  • customer_vpa.failed Failed to fetch VPA details

{
   // Event attributes
   "eventId": "01ARZ3NDEKTSV4RRFFQ69G5FAV", // Id of an event (unique for each event)
   "eventTs": "2023-09-04T12:08:20+0530", // Timestamp associated with the event
   "eventType": "customer_vpa.valid",
   "resource": "customer_vpa",
   "status": "valid",
   "merchantId": "01ARZ3NDEKTSV4RRFFQ69G5FAV",
   "merchantReferenceId": "01ARZ3NDEKTSV4RRFFQ69G5FAV",
   "id": "01ARZ3NDEKTSV4RRFFQ69G5FAV",
   "customerVpa": "deku20231030@pineaxis",
   "customerName": "dekup",
   "customerAccountType": "SAVINGS", // SAVINGS, CREDIT,...
   "reason": {}
}
{
   // Event attributes
   "eventId": "01ARZ3NDEKTSV4RRFFQ69G5FAV", // Id of an event (unique for each event)
   "eventTs": "2023-09-04T12:08:20+0530", // Timestamp associated with the event
   "eventType": "customer_vpa.invalid",
   "resource": "customer_vpa",
   "status": "invalid",
   "merchantId": "01ARZ3NDEKTSV4RRFFQ69G5FAV",
   "merchantReferenceId": "01ARZ3NDEKTSV4RRFFQ69G5FAV",
   "id": "01ARZ3NDEKTSV4RRFFQ69G5FAV",
   "customerVpa": "deku20231030@pineaxis",
   "reason": {}
}
{
   // Event attributes
   "eventId": "01ARZ3NDEKTSV4RRFFQ69G5FAV", // Id of an event (unique for each event)
   "eventTs": "2023-09-04T12:08:20+0530", // Timestamp associated with the event
   "eventType": "customer_vpa.failed",
   "resource": "customer_vpa",
   "status": "failed",
   "merchantId": "01ARZ3NDEKTSV4RRFFQ69G5FAV",
   "merchantReferenceId": "01ARZ3NDEKTSV4RRFFQ69G5FAV",
   "id": "01ARZ3NDEKTSV4RRFFQ69G5FAV",
   "customerVpa": "deku20231030@pineaxis",
   "reason": {}
}

On this page