Add Money to Brand Wallet

POST/api/pay/v1/add_money

Adds money to a customer's brand wallet. Supports two modes:

  • GIFT_CARD — Provide gift card number and PIN in payment_option.gift_card_details. Funds credited immediately.
  • CASH — Provide amount and UPI payment details in payment_option.upi_details. Creates a parent ADD_MONEY order and child CHARGE order for UPI payment.
Requires Bearer token. Get token →

Request Body

NameTypeDescription
merchant_order_reference
stringrequired

Unique reference for this add-money request

mode
GIFT_CARD | CASHrequired

Mode of adding money:

  • GIFT_CARD — Provide gift card number and PIN. Funds credited immediately.
  • CASH — Provide amount. Creates a UPI payment order.
GIFT_CARDCASH
amount
object

Monetary amount with currency.

value
integerrequired

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

currency
stringrequired

Three-letter ISO 4217 currency code.

payment_option
objectrequired
  • For GIFT_CARD mode: provide gift_card_details with gift_card_number and pin.
  • For CASH mode: provide upi_details with UPI Collect or Intent details.
gift_card_details
object
upi_details
object

UPI payment details.

  • For COLLECT flow: txn_mode = "COLLECT" and payer.vpa is required.
  • For INTENT flow (includes QR): txn_mode = "INTENT" and no payer needed.
customer
objectrequired

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.

merchant_metadata
object

Arbitrary key/value pairs attached to the order

Status Codes

201Money added successfully.
400
401
422Unprocessable entity.
500
Request
curl -X POST "https://api.pluralpay.in/api/pay/v1/add_money" \
  -H "Authorization: Bearer $ACCESS_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
  "merchant_order_reference": "ADD-GC-001",
  "mode": "GIFT_CARD",
  "payment_option": {
    "gift_card_details": {
      "gift_card_number": "GC1234567890",
      "pin": "123456"
    }
  },
  "customer": {
    "customer_id": "cust-bw-001"
  }
}'

Run this request

New chat
Responses are generated using AI and may contain mistakes.
Hi! I'm Pine, your AI developer assistant. Ask me anything about Pine Labs APIs, integrations, or troubleshooting.

Tip: you can create a new chat with ⌘ + E