Skip to main content
POST
/
points
/
add
curl --request POST \
  --url https://webmaster.zupers.com.br/api/loyalty/v1/points/add/ \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "customer_id": "cust_1234567890",
  "points": 150,
  "transaction_type": "purchase",
  "reference_id": "order_789012345",
  "description": "Points earned from purchase",
  "metadata": {
    "order_value": 75.5,
    "payment_method": "credit_card"
  }
}
'
{
  "success": true,
  "transaction_id": "txn_points_add_987654321",
  "customer_id": "cust_1234567890",
  "points_added": 150,
  "new_balance": 1400,
  "tier_updated": false,
  "new_tier": "Silver",
  "timestamp": "2023-11-07T05:31:56Z"
}

Authorizations

​
Authorization
string
header
required

Use format: Bearer ZsCUqECc9aCQtN5z9z9sTs81933YnklP

Body

application/json
​
customer_id
string
required
Example:

"cust_1234567890"

​
points
integer
required
Required range: x >= 1
Example:

150

​
transaction_type
enum<string>
required
Available options:
purchase,
bonus,
referral,
adjustment,
promotion
Example:

"purchase"

​
reference_id
string
Example:

"order_789012345"

​
description
string
Example:

"Points earned from purchase at Miola Restaurante"

​
metadata
object
Example:
{
  "order_value": 75.5,
  "payment_method": "credit_card",
  "location": "store_001"
}

Response

Points added successfully

​
success
boolean
Example:

true

​
transaction_id
string
Example:

"txn_points_add_987654321"

​
customer_id
string
Example:

"cust_1234567890"

​
points_added
integer
Example:

150

​
new_balance
integer
Example:

1400

​
tier_updated
boolean
Example:

false

​
new_tier
string
Example:

"Silver"

​
timestamp
string<date-time>