Validate Brand Wallet

POST/payment-option/wallet/validate

Validates that a customer's wallet can fulfil a payment of the given amount. Call this before creating an order to confirm the wallet balance is sufficient. Returns the eligible amount and whether redemption is allowed.

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

Requires Bearer token. Get token →

Request Body

Name	Type	Description
`notes`	`string`
`amount`	`object`required	Monetary amount with currency.
`value`	`integer`required	Amount in the smallest currency unit (e.g., paisa for INR).
`currency`	`string`required	Three-letter ISO 4217 currency code.
`customers`	`object`required	Customer information.
`email_id`	`string`	Customer's email address.
`first_name`	`string`	Customer's first name.
`last_name`	`string`	Customer's last name.
`customer_id`	`string`	Unique identifier of the customer.
`mobile_number`	`string`	Customer's mobile number.
`country_code`	`string`	Country code of the registered mobile number. Defaults to 91.
`billing_address`	`object`	Physical address.
`shipping_address`	`object`	Physical address.
`is_edit_customer_details_allowed`	`boolean`	Whether the customer is allowed to edit their details.

Response

Name	Type	Description
`eligible_amount`	`object`	Monetary amount with currency.
`value`	`integer`required	Amount in the smallest currency unit (e.g., paisa for INR).
`currency`	`string`required	Three-letter ISO 4217 currency code.
`total_balance_amount`	`object`	Monetary amount with currency.
`value`	`integer`required	Amount in the smallest currency unit (e.g., paisa for INR).
`currency`	`string`required	Three-letter ISO 4217 currency code.
`redemption_allowed`	`boolean`	Whether the wallet can be used for this transaction
`notes`	`string`	Additional validation notes

Status Codes

`200`	Wallet validation result.
`400`
`401`
`422`	Unprocessable entity.
`500`

Request

curl --request POST \
  --url https://pluraluat.v2.pinepg.in/payment-option/wallet/validate \
  --header 'Authorization: Bearer YOUR_ACCESS_TOKEN' \
  --header 'Content-Type: application/json' \
  --data '{
  "amount": {
    "value": 50000,
    "currency": "INR"
  },
  "customers": {
    "email_id": "john@example.com",
    "first_name": "Kevin",
    "last_name": "Bob",
    "customer_id": "123456",
    "mobile_number": "9876543210",
    "country_code": "91",
    "billing_address": {
      "address1": "10 Downing Street Westminster London",
      "address2": "Oxford Street Westminster London",
      "address3": "Baker Street Westminster London",
      "pincode": "51524036",
      "city": "Westminster",
      "state": "Westminster",
      "country": "London",
      "full_name": "Kevin Bob",
      "adddress_type": "Home",
      "address_category": "billing"
    },
    "shipping_address": {
      "address1": "10 Downing Street Westminster London",
      "address2": "Oxford Street Westminster London",
      "address3": "Baker Street Westminster London",
      "pincode": "51524036",
      "city": "Westminster",
      "state": "Westminster",
      "country": "London",
      "full_name": "Kevin Bob",
      "adddress_type": "Home",
      "address_category": "billing"
    },
    "is_edit_customer_details_allowed": false
  }
}'

Run this request

Bearer token

Request body (JSON)

{
  "amount": {
    "value": 50000,
    "currency": "INR"
  },
  "customers": {
    "email_id": "john@example.com",
    "first_name": "Kevin",
    "last_name": "Bob",
    "customer_id": "123456",
    "mobile_number": "9876543210",
    "country_code": "91",
    "billing_address": {
      "address1": "10 Downing Street Westminster London",
      "address2": "Oxford Street Westminster London",
      "address3": "Baker Street Westminster London",
      "pincode": "51524036",
      "city": "Westminster",
      "state": "Westminster",
      "country": "London",
      "full_name": "Kevin Bob",
      "adddress_type": "Home",
      "address_category": "billing"
    },
    "shipping_address": {
      "address1": "10 Downing Street Westminster London",
      "address2": "Oxford Street Westminster London",
      "address3": "Baker Street Westminster London",
      "pincode": "51524036",
      "city": "Westminster",
      "state": "Westminster",
      "country": "London",
      "full_name": "Kevin Bob",
      "adddress_type": "Home",
      "address_category": "billing"
    },
    "is_edit_customer_details_allowed": false
  }
}

200 OK

{
  "eligible_amount": {
    "value": 50000,
    "currency": "INR"
  },
  "total_balance_amount": {
    "value": 50000,
    "currency": "INR"
  }
}