Create a Brand Wallet

POST/payment-option/create/wallet

Creates brand wallets for one or more customers. The customers array must not be empty. After creation, activate the wallet before it can be used for transactions.

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
`currency_code` `string`	ISO 4217 currency code for the wallet
`customers` `CustomerDetails[]`required9 nested fields	List of customers for whom wallets should be created Constraints Minimum items: 1
`notes` `string`	Free-text notes attached to the wallet creation request

Response

Field	Details
`currency_code` `string`	ISO 4217 currency code for the created wallets
`customers` `CustomerDetails[]`9 nested fields	List of customers whose wallets were successfully activated
`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` `object`10 nested fields	Physical address.
`shipping_address` `object`10 nested fields	Physical address.
`is_edit_customer_details_allowed` `boolean`	Whether the customer is allowed to edit their details.
`notes` `string`	Notes from the creation request

Status Codes

`200`	Wallets created successfully.
`400`	The request was malformed or missing required fields.
`401`	Authentication failed — missing, expired, or invalid Bearer token.
`422`	Unprocessable entity.
`500`	An unexpected error occurred on the server.

Run

Request

curl --request POST \
  --url https://pluraluat.v2.pinepg.in/payment-option/create/wallet \
  --header 'Authorization: Bearer YOUR_ACCESS_TOKEN' \
  --header 'Content-Type: application/json' \
  --header 'Request-ID: a1b2c3d4-e5f6-7890-abcd-ef1234567890' \
  --header 'Request-Timestamp: 2024-10-01T10:30:00Z' \
  --data '{
  "currency_code": "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
    }
  ]
}'

Status:

{
  "currency_code": "INR",
  "customers": [
    {
      "customer_id": "cust-bw-001",
      "first_name": "Rahul",
      "last_name": "Sharma",
      "mobile_number": "9876543210",
      "country_code": "91",
      "email_id": "rahul@example.com"
    }
  ],
  "notes": "Onboarding wallets"
}