Create Customer

POST/api/v1/customer

Create a new customer profile in the Pine Labs Online system. The customer profile can be used for tokenization and recurring payment operations.

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

Requires Bearer token. Get token →

Request Body

Name	Type	Description
`merchant_customer_reference`	`string`	Unique customer reference assigned by the merchant.
`first_name`	`string`	Customer's first name.
`last_name`	`string`	Customer's last name.
`country_code`	`string`	Country code of the registered mobile number. Defaults to 91.
`mobile_number`	`string`	Customer's mobile number.
`email_id`	`string`	Customer's email address.
`billing_address`	`object`	Physical address.
`address1`	`string`	Address line 1.
`address2`	`string`	Address line 2.
`address3`	`string`	Address line 3.
`pincode`	`string`	Postal/ZIP code.
`city`	`string`	City name.
`state`	`string`	State or province.
`country`	`string`	Country name.
`full_name`	`string`	Full name of the address holder.
`adddress_type`	`string`	Type of address (e.g., Home, Office).
`address_category`	`billing \| shipping`	Category of the address. `billingshipping`
`shipping_address`	`object`	Physical address.
`address1`	`string`	Address line 1.
`address2`	`string`	Address line 2.
`address3`	`string`	Address line 3.
`pincode`	`string`	Postal/ZIP code.
`city`	`string`	City name.
`state`	`string`	State or province.
`country`	`string`	Country name.
`full_name`	`string`	Full name of the address holder.
`adddress_type`	`string`	Type of address (e.g., Home, Office).
`address_category`	`billing \| shipping`	Category of the address. `billingshipping`
`gstin`	`string`	Customer's unique GSTIN (Goods and Services Tax Identification Number).
`merchant_metadata`	`object`	Arbitrary key-value pairs for merchant use. Maximum 10 pairs, 256 characters each.

Status Codes

`201`	Customer created successfully.
`400`
`401`
`403`
`500`

Request

curl --request POST \
  --url https://pluraluat.v2.pinepg.in/api/v1/customer \
  --header 'Authorization: Bearer YOUR_ACCESS_TOKEN' \
  --header 'Content-Type: application/json' \
  --data '{
  "merchant_customer_reference": "82d57572-057c-4826-5775-385a52150554",
  "first_name": "Kevin",
  "last_name": "Bob",
  "country_code": "91",
  "mobile_number": "9876543210",
  "email_id": "kevin@example.com",
  "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"
  },
  "gstin": "28ABCDE1234F2Z6",
  "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"
  }
}'

Run this request

Bearer token

Request body (JSON)

{
  "merchant_customer_reference": "82d57572-057c-4826-5775-385a52150554",
  "first_name": "Kevin",
  "last_name": "Bob",
  "country_code": "91",
  "mobile_number": "9876543210",
  "email_id": "kevin@example.com",
  "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"
  },
  "gstin": "28ABCDE1234F2Z6",
  "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"
  }
}