Adjust account balance
curl --request POST \
--url https://{domain}/api/application/users/{user}/balance \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"action": "add",
"amount": 25,
"reason": "Goodwill credit",
"notify_user": false
}
'import requests
url = "https://{domain}/api/application/users/{user}/balance"
payload = {
"action": "add",
"amount": 25,
"reason": "Goodwill credit",
"notify_user": False
}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({action: 'add', amount: 25, reason: 'Goodwill credit', notify_user: false})
};
fetch('https://{domain}/api/application/users/{user}/balance', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://{domain}/api/application/users/{user}/balance",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'action' => 'add',
'amount' => 25,
'reason' => 'Goodwill credit',
'notify_user' => false
]),
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"Content-Type: application/json"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://{domain}/api/application/users/{user}/balance"
payload := strings.NewReader("{\n \"action\": \"add\",\n \"amount\": 25,\n \"reason\": \"Goodwill credit\",\n \"notify_user\": false\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Authorization", "Bearer <token>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://{domain}/api/application/users/{user}/balance")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"action\": \"add\",\n \"amount\": 25,\n \"reason\": \"Goodwill credit\",\n \"notify_user\": false\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://{domain}/api/application/users/{user}/balance")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"action\": \"add\",\n \"amount\": 25,\n \"reason\": \"Goodwill credit\",\n \"notify_user\": false\n}"
response = http.request(request)
puts response.read_body{
"data": {
"balance": 25
},
"message": "User balance updated.",
"meta": {
"request_id": "a51ec71a-0a70-44b9-b32b-9d9e36ed06a5"
}
}User actions
Adjust account balance
Adds, removes or sets account credit. Every change is written to the credit ledger with the reason, and the user gets an in-app notification unless notify_user is false.
Permission: users.balance
POST
/
users
/
{user}
/
balance
Adjust account balance
curl --request POST \
--url https://{domain}/api/application/users/{user}/balance \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"action": "add",
"amount": 25,
"reason": "Goodwill credit",
"notify_user": false
}
'import requests
url = "https://{domain}/api/application/users/{user}/balance"
payload = {
"action": "add",
"amount": 25,
"reason": "Goodwill credit",
"notify_user": False
}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({action: 'add', amount: 25, reason: 'Goodwill credit', notify_user: false})
};
fetch('https://{domain}/api/application/users/{user}/balance', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://{domain}/api/application/users/{user}/balance",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'action' => 'add',
'amount' => 25,
'reason' => 'Goodwill credit',
'notify_user' => false
]),
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"Content-Type: application/json"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://{domain}/api/application/users/{user}/balance"
payload := strings.NewReader("{\n \"action\": \"add\",\n \"amount\": 25,\n \"reason\": \"Goodwill credit\",\n \"notify_user\": false\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Authorization", "Bearer <token>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://{domain}/api/application/users/{user}/balance")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"action\": \"add\",\n \"amount\": 25,\n \"reason\": \"Goodwill credit\",\n \"notify_user\": false\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://{domain}/api/application/users/{user}/balance")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"action\": \"add\",\n \"amount\": 25,\n \"reason\": \"Goodwill credit\",\n \"notify_user\": false\n}"
response = http.request(request)
puts response.read_body{
"data": {
"balance": 25
},
"message": "User balance updated.",
"meta": {
"request_id": "a51ec71a-0a70-44b9-b32b-9d9e36ed06a5"
}
}Authorizations
Body
application/json
Was this page helpful?

