API Playground

Test Pine Labs API endpoints with real requests. All endpoints are loaded dynamically from the OpenAPI specification.

Authentication

Orders

Refunds

Settlements

Split Settlements

Checkout

Payment Links

Card Payments

UPI Payments

NetBanking

Wallet

Pay by Points

E-Challans

Apple Pay

International Payments

Customers

Tokenization

Payouts

Affordability Suite

BNPL

Convenience Fee

Payment Option

Brand Wallet

Brand Wallet Payments

Subscriptions - Plans

Subscriptions - Subscriptions

Subscriptions - Presentations

UPI Reserve Pay

108 endpoints from openapi.yaml

Validate Brand Wallet for Payment

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.

Server

POSThttps://pluraluat.v2.pinepg.in/payment-option/wallet/validate

Bearer

Required

Request Body (editable 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",
      "address_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",
      "address_type": "Home",
      "address_category": "billing"
    },
    "is_edit_customer_details_allowed": false
  }
}

Request Body Schemarequired

FieldDetails

notes

string

amount

objectrequired2 nested fields

Monetary amount with currency.

value

integerrequired

Amount in the smallest currency unit (e.g., paisa for INR).

Constraints

Minimum value: 100Maximum value: 50000000000

currency

stringrequired

Three-letter ISO 4217 currency code.

Constraints

Default value: INR

customers

objectrequired9 nested fields

Customer whose wallet to validate (customer_id required)

email_id

string

Customer's email address.

Constraints

Minimum length: 1 characterMaximum length: 100 characters

Pattern: ^[-!#$%&'*+/0-9=?A-Z^_a-z{|}~](\.?[-!#$%&'*+/0-9=?A-Z^_a-z{|}~])*@([\w-]+\.)+[\w-]+$

first_name

string

Customer's first name.

Constraints

Maximum length: 50 characters

Pattern: ^[\p{L}\p{M}\p{Nd}\s/\-,.'_]*$

last_name

string

Customer's last name.

Constraints

Maximum length: 50 characters

Pattern: ^[\p{L}\p{M}\p{Nd}\s/\-,.'_]*$

customer_id

string

Unique identifier of the customer.

Constraints

Minimum length: 1 characterMaximum length: 100 characters

mobile_number

string

Customer's mobile number. Must be a valid phone number for the given country_code.

Constraints

Minimum length: 10 charactersMaximum length: 20 characters

country_code

string

Country code of the registered mobile number. Defaults to 91.

Constraints

Maximum length: 5 characters

Pattern: ^\+?\d{1,5}$

billing_address

object10 nested fields

Physical address.

address1

string

Address line 1.

Constraints

Maximum length: 100 characters

address2

string

Address line 2.

Constraints

Maximum length: 100 characters

address3

string

Address line 3.

Constraints

Maximum length: 100 characters

pincode

string

Postal/ZIP code.

Constraints

Minimum length: 3 charactersMaximum length: 11 characters

Pattern: ^[a-zA-Z0-9 \-]*$

city

string

City name.

Constraints

Maximum length: 50 characters

Pattern: ^[\p{L}\p{M}\p{Nd}\s\-'&.()]*$

state

string

State or province.

Constraints

Maximum length: 50 characters

Pattern: ^[\p{L}\p{M}\p{Nd}\s\-'&.]*$

country

string

Country name.

Constraints

Maximum length: 50 characters

Pattern: ^[\p{L}\p{M}\p{Nd}\s\-'&.]*$

full_name

string

Full name of the address holder.

Constraints

Maximum length: 100 characters

Pattern: ^[\p{L}\p{M}\p{Nd}\s/\-,.'_]*$

address_type

string

Type of address (e.g., Home, Office).

Constraints

Maximum length: 20 characters

address_category

string

Category of the address.

Allowed values

billingshipping

Constraints

Maximum length: 20 characters

shipping_address

object10 nested fields

Physical address.

address1

string

Address line 1.

Constraints

Maximum length: 100 characters

address2

string

Address line 2.

Constraints

Maximum length: 100 characters

address3

string

Address line 3.

Constraints

Maximum length: 100 characters

pincode

string

Postal/ZIP code.

Constraints

Minimum length: 3 charactersMaximum length: 11 characters

Pattern: ^[a-zA-Z0-9 \-]*$

city

string

City name.

Constraints

Maximum length: 50 characters

Pattern: ^[\p{L}\p{M}\p{Nd}\s\-'&.()]*$

state

string

State or province.

Constraints

Maximum length: 50 characters

Pattern: ^[\p{L}\p{M}\p{Nd}\s\-'&.]*$

country

string

Country name.

Constraints

Maximum length: 50 characters

Pattern: ^[\p{L}\p{M}\p{Nd}\s\-'&.]*$

full_name

string

Full name of the address holder.

Constraints

Maximum length: 100 characters

Pattern: ^[\p{L}\p{M}\p{Nd}\s/\-,.'_]*$

address_type

string

Type of address (e.g., Home, Office).

Constraints

Maximum length: 20 characters

address_category

string

Category of the address.

Allowed values

billingshipping

Constraints

Maximum length: 20 characters

is_edit_customer_details_allowed

boolean

Whether the customer is allowed to edit their details.