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

Create a Payment Order

An order contains the total amount and the purchase details against an order. For every order, we generate a unique order ID. It ensures that each order can be identified, referenced, and accessed without confusion or ambiguity. This order_id must be used in our payments API to accept payment against an order.

Server

POSThttps://pluraluat.v2.pinepg.in/api/pay/v1/orders

Bearer

Required

Request Body (editable JSON)

{
  "merchant_order_reference": "112345",
  "order_amount": {
    "value": 50000,
    "currency": "INR"
  },
  "pre_auth": false,
  "allowed_payment_methods": [
    "CARD",
    "UPI",
    "NETBANKING",
    "POINTS",
    "WALLET"
  ],
  "notes": "order1",
  "callback_url": "https://sample-callback-url",
  "failure_callback_url": "https://sample-failure-callback-url",
  "purchase_details": {
    "customer": {
      "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
    },
    "merchant_metadata": {
      "clientId": "DD",
      "transactionReferenceNo": "pine-1223",
      "merchantId": "1234",
      "tid": "9000990",
      "acquirerName": "HDFC_FSS",
      "isOfferDisplayRequired": "true",
      "OfferData": "UHJvZHVjdF9Db2RlPSIgIiZQcm9kdWN0X05hbWU9IiImUGF5bWVudF9Nb2RlPUJhbmsgRU1JJkNhcmRfVHlwZT1EZWJpdCBDYXJkJkJhbmtfTmFtZT1IREZDIERlYml0JkVNSV9UZW51cmU9NiZJbnRlcmVzdF9SYXRlPTkuMCZJbnRlcmVzdF9BbW91bnQ9MTM4MTQwJk1vbnRobHlfSW5zdGFsbG1lbnQ9ODk0NjkwJkF1dGhvcml6YXRpb25fQW1vdW50PTEwMCZMb2FuX2Jvb2tpbmdfQW1vdW50PTUyMzAwMDAmSW50ZXJlc3RfQ2FzaGJhY2tfQW1vdW50PTAmSW50ZXJlc3RfQ2FzaGJhY2tfVHlwZT1EZWZlcnJlZCZBZGRpdGlvbmFsX0Nhc2hiYWNrPSIiJkFkZGl0aW9uYWxfQ2FzaGJhY2tfVHlwZT0iIiZEZXNjcmlwdGlvbj1CYW5rIEVNSSZQcm9kdWN0X1ZhbHVlPTUyMzAwMDA",
      "tenant_id": "PGATPOS",
      "is_offer_validation_required": "true"
    },
    "cart_details": {
      "cart_items": [
        {
          "item_id": "9876",
          "item_name": "T Shirt",
          "item_description": "Shopping on Diwali Sale",
          "item_details_url": "https://chriscross.in/cdn/shop/files/95_800x.jpg",
          "item_image_url": "https://chriscross.in/cdn/shop/files/95_800x.jpg",
          "item_original_unit_price": 199,
          "item_discounted_unit_price": 149,
          "item_quantity": 2,
          "item_currency": "INR"
        }
      ]
    }
  },
  "split_info": {
    "split_type": "AMOUNT",
    "split_details": [
      {
        "split_merchant_id": "1324",
        "split_settlement_id": "v1-241118074845-aa-wduUQF-ss-b",
        "merchant_settlement_reference": "kshjhfk",
        "amount": {
          "value": 50000,
          "currency": "INR"
        },
        "on_hold": true,
        "status": "HOLD",
        "updated_at": "2024-11-18T07:48:45.324Z"
      }
    ]
  },
  "is_mcc_transaction": "true",
  "base_amount": {
    "value": 50000,
    "currency": "INR"
  },
  "cart_coupon_discount_amount": {
    "value": 50000,
    "currency": "INR"
  },
  "cross_border_details": {
    "settlement_currency": "USD",
    "hs_code": "8471300000",
    "hs_description": "Portable digital automatic data processing machines",
    "iec_code": "0512345678"
  }
}

Request Body Schemarequired

FieldDetails

merchant_order_reference

stringrequired

**Idempotency Key.** Unique order reference assigned by the merchant. Duplicate requests with the same `merchant_order_reference` will return the existing order instead of creating a new one.

Constraints

Minimum length: 1 characterMaximum length: 50 characters

order_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

pre_auth

boolean

Whether pre-authorization is needed.

allowed_payment_methods

string[]

Payment methods to offer the customer.

Constraints

Allowed item values:

CARDUPINETBANKINGPOINTSWALLETCREDIT_EMIDEBIT_EMIBNPLCARDLESS_EMI

notes

string

Note to show against the order.

Constraints

Maximum length: 100 characters

callback_url

string

URL to redirect customers after successful payment.

failure_callback_url

string

URL to redirect customers after failed payment. If not provided, callback_url is used for both.

purchase_details

object3 nested fields

Purchase details including customer information.

customer

object9 nested fields

Customer information.

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.

merchant_metadata

object

Arbitrary key-value pairs for merchant use. Maximum 10 pairs, 256 characters each.

Constraints

Maximum properties: 10

Additional properties: string · Maximum length: 256 characters

cart_details

object1 nested field

Cart details for the purchase.

cart_items

CartItem[]9 nested fields

Array of cart items.

item_id

string

Unique identifier of the item.

item_name

string

Name of the item.

item_description

string

Description of the item.

item_details_url

string

Item details URL.

item_image_url

string

Image URL of the item (24x24 recommended).

item_original_unit_price

integer

Original price of the item.

item_discounted_unit_price

integer

Discounted price of the item.

item_quantity

integer

Number of items purchased.

item_currency

string

Currency type for the item purchase.

split_info

object2 nested fields

Split settlement information for marketplace flows.

split_type

string

Type of split.

split_details

SplitDetail[]7 nested fields

Array of split details.

split_merchant_id

string

Unique identifier of the partner merchant.

split_settlement_id

string

Unique identifier of the split settlement.

Constraints

Maximum length: 50 characters

merchant_settlement_reference

string

Unique identifier entered while creating an order in split.

Constraints

Maximum length: 50 characters

amount

object2 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

on_hold

boolean

Whether the settlement is on hold for future release.

status

string

Split settlement status.

Allowed values

RELEASEDHOLD

updated_at

stringdate-time

ISO 8601 UTC timestamp when the split order was created.

is_mcc_transaction

string

Identifies the order type for MCC transactions. Set to "true" for MCC transactions.

base_amount

object2 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

cart_coupon_discount_amount

object2 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

cross_border_details

object4 nested fields

Cross-border payment details for Cross Border Import enabled merchants. Required when the merchant is enabled for cross-border transactions.

settlement_currency

string

The currency in which the merchant wants to receive settlement. Defaults to the default settlement currency configured during merchant onboarding.

hs_code

string

Harmonized System (HS) code for the goods/services being traded. Must be a 6-to-10 digit numeric code. Required when commodity_type is GOODS.

Constraints

Pattern: ^\d{6,10}$

hs_description

string

Description of the goods/services corresponding to the HS code. Required when commodity_type is GOODS.

Constraints

Maximum length: 200 characters

iec_code

string

Importer-Exporter Code (IEC) issued by DGFT, India. Must be a 1-to-10 digit numeric code.

Constraints

Pattern: ^\d{1,10}$