Verify VPA

POST/payment-option

Verifies a customer's UPI VPA details or checks reward points balance. Supports fetching UPI VPA details based on the payer's phone number, as well as checking reward points balance and card eligibility.

View as Markdown Open in ChatGPT Open in Claude Open in Perplexity

Requires Bearer token. Get token →

Request Body

Name	Type	Description
`payment_method`	`UPI \| POINTS`	Type of payment method to check eligibility for. `UPIPOINTS`
`payment_option`	`object`required	An object that contains the payment option details. Use `upi_details` for UPI or `points_card_details` for points. One is mandatory to process the request.
`upi_details`	`object`	UPI-specific payment option details.
`points_card_details`	`object`	Mandatory when payment_method is `POINTS`. An object that contains the point card details.
`order_details`	`object`	Order details for the points balance check. Required when using points_card_details.
`order_amount`	`object`required	Order amount for the points balance check.

Response

Name	Type	Description
`payment_method`	`UPI \| POINTS`	The payment method checked. `UPIPOINTS`
`payment_option_metadata`	`object`	Metadata returned for the payment option.
`upi_payment_option_data`	`object`	UPI-specific metadata.
`balance`	`object`	Card balance details. Returned for points payment method.
`value`	`integer`	Balance available on the card (in paisa).
`currency`	`string`
`redeemable_amount`	`object`	Redeemable amount details. Returned for points payment method.
`value`	`integer`	Redeemable amount on card (in paisa).
`currency`	`string`
`redeemable_points`	`integer`	Total redeemable points available on the card.
`is_eligible`	`boolean`	Card eligibility status for pay by points.

Status Codes

`200`	Payment option eligibility or points balance response.
`400`
`401`
`422`	Unprocessable Entity — card not eligible or invalid request.
`500`

Example:

Request

curl -X POST "https://api.pluralpay.in/payment-option" \
  -H "Authorization: Bearer $ACCESS_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
  "payment_option": {
    "upi_details": {
      "payer": {
        "fetch_vpa": true,
        "phone_number": "9876543210"
      }
    }
  },
  "payment_method": "UPI"
}'

Run this request

Bearer token

Request body (JSON)

200 OK

{
  "payment_method": "UPI",
  "payment_option_metadata": {
    "upi_payment_option_data": {
      "fetched_vpa": "customer@okaxis"
    }
  },
  "balance": {
    "value": 23718050,
    "currency": "INR"
  },
  "redeemable_amount": {
    "value": 3500,
    "currency": "INR"
  },
  "redeemable_points": 140,
  "is_eligible": true
}