Get Payment Option API

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 →

Header Parameters

Field	Details
`Request-Timestamp` `string`date-time	ISO 8601 UTC timestamp of the request. Used for idempotency and audit.
`Request-ID` `string`	Use a global unique identifier [GUID] for the request. Constraints Minimum length: 1 characterMaximum length: 50 characters

Request Bodyrequired

Field	Details
`payment_method` `string`	Type of payment method to check eligibility for. Allowed values: `UPIPOINTS`
`payment_option` `object`required2 nested fields	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.
`order_details` `object`1 nested field	Order details for the points balance check. Required when using points_card_details.

Response

Field	Details
`payment_method` `string`	The payment method checked. Allowed values: `UPIPOINTS`
`payment_option_metadata` `object`1 nested field	Metadata returned for the payment option.
`upi_payment_option_data` `object`1 nested field	UPI-specific metadata.
`balance` `object`2 nested fields	Card balance details. Returned for points payment method.
`redeemable_amount` `object`2 nested fields	Redeemable amount details. Returned for points payment method.
`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`	The request was malformed or missing required fields.
`401`	Authentication failed — missing, expired, or invalid Bearer token.
`422`	Unprocessable Entity — card not eligible or invalid request.
`500`	An unexpected error occurred on the server.

Example:

Run

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"
}'

Status:

{
  "payment_method": "UPI",
  "payment_option_metadata": {
    "upi_payment_option_data": {
      "fetched_vpa": "customer@okaxis"
    }
  }
}