Load Money into Brand Wallet

POST/payment-option/wallet/load

Loads a specified amount into a customer's brand wallet. The loaded amount is added to the specified bucket (e.g. CASH, PROMOTIONAL).

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

Requires Bearer token. Get token →

Request Body

Name	Type	Description
`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.
`customer`	`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.
`bucket`	`string`	Load bucket type (e.g. CASH, PROMOTIONAL)
`notes`	`string`required

Response

Name	Type	Description
`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.
`notes`	`string`
`created_at`	`string`
`native_currency`	`string`
`buckets`	`BrandWalletBalanceBucket[]`
`currency_code`	`string`
`number_of_cards`	`integer`	Number of instruments in this bucket
`balance`	`integer`	Bucket balance in lowest currency denomination (paisa)
`type`	`string`	Bucket type (e.g. CASH, PROMOTIONAL)
`payment_instruments`	`BrandWalletPaymentInstrument[]`

Status Codes

`200`	Money loaded successfully.
`400`
`401`
`500`

Request

curl --request POST \
  --url https://pluraluat.v2.pinepg.in/payment-option/wallet/load \
  --header 'Authorization: Bearer YOUR_ACCESS_TOKEN' \
  --header 'Content-Type: application/json' \
  --data '{
  "amount": {
    "value": 50000,
    "currency": "INR"
  },
  "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",
      "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
  },
  "bucket": "CASH",
  "notes": "your_notes"
}'

Run this request

Bearer token

Request body (JSON)

{
  "amount": {
    "value": 50000,
    "currency": "INR"
  },
  "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",
      "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
  },
  "bucket": "CASH",
  "notes": "your_notes"
}

200 OK

{
  "total_balance_amount": {
    "value": 50000,
    "currency": "INR"
  },
  "native_currency": "INR",
  "buckets": [
    {
      "currency_code": "INR",
      "payment_instruments": []
    }
  ]
}