Rewards
Create reward
Create a new reward.
POST
/
v3
/
rewards
Create reward
curl --request POST \
--url https://api.example.com/v3/rewards \
--header 'Content-Type: application/json-patch+json' \
--data '
{
"partnerId": 123,
"amount": 123,
"comment": "<string>",
"currency": "<string>",
"properties": {}
}
'import requests
url = "https://api.example.com/v3/rewards"
payload = {
"partnerId": 123,
"amount": 123,
"comment": "<string>",
"currency": "<string>",
"properties": {}
}
headers = {"Content-Type": "application/json-patch+json"}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {'Content-Type': 'application/json-patch+json'},
body: JSON.stringify({
partnerId: 123,
amount: 123,
comment: '<string>',
currency: '<string>',
properties: {}
})
};
fetch('https://api.example.com/v3/rewards', 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://api.example.com/v3/rewards",
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([
'partnerId' => 123,
'amount' => 123,
'comment' => '<string>',
'currency' => '<string>',
'properties' => [
]
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json-patch+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://api.example.com/v3/rewards"
payload := strings.NewReader("{\n \"partnerId\": 123,\n \"amount\": 123,\n \"comment\": \"<string>\",\n \"currency\": \"<string>\",\n \"properties\": {}\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Content-Type", "application/json-patch+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://api.example.com/v3/rewards")
.header("Content-Type", "application/json-patch+json")
.body("{\n \"partnerId\": 123,\n \"amount\": 123,\n \"comment\": \"<string>\",\n \"currency\": \"<string>\",\n \"properties\": {}\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.example.com/v3/rewards")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Content-Type"] = 'application/json-patch+json'
request.body = "{\n \"partnerId\": 123,\n \"amount\": 123,\n \"comment\": \"<string>\",\n \"currency\": \"<string>\",\n \"properties\": {}\n}"
response = http.request(request)
puts response.read_body{
"id": 123,
"uniqueId": "<string>",
"partnerId": 123,
"dealId": 123,
"status": "Unknown",
"creationDate": "2023-11-07T05:31:56Z",
"amount": {
"value": 123,
"currency": "<string>"
},
"payoutId": 123,
"comment": "<string>",
"rewardType": "Unknown",
"properties": {}
}{
"errorCode": "Transactions.InvalidCustomerIdentifier",
"errorMessage": "You must specify one customer identifier"
}Body
application/json-patch+jsonapplication/jsontext/jsonapplication/*+json
Response
Reward created
Available options:
Unknown, Pending, Accepted, Paid, Declined Show child attributes
Show child attributes
Available options:
Unknown, Cash, Coupon, Credit, GiftCard Show child attributes
Show child attributes
Create reward
curl --request POST \
--url https://api.example.com/v3/rewards \
--header 'Content-Type: application/json-patch+json' \
--data '
{
"partnerId": 123,
"amount": 123,
"comment": "<string>",
"currency": "<string>",
"properties": {}
}
'import requests
url = "https://api.example.com/v3/rewards"
payload = {
"partnerId": 123,
"amount": 123,
"comment": "<string>",
"currency": "<string>",
"properties": {}
}
headers = {"Content-Type": "application/json-patch+json"}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {'Content-Type': 'application/json-patch+json'},
body: JSON.stringify({
partnerId: 123,
amount: 123,
comment: '<string>',
currency: '<string>',
properties: {}
})
};
fetch('https://api.example.com/v3/rewards', 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://api.example.com/v3/rewards",
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([
'partnerId' => 123,
'amount' => 123,
'comment' => '<string>',
'currency' => '<string>',
'properties' => [
]
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json-patch+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://api.example.com/v3/rewards"
payload := strings.NewReader("{\n \"partnerId\": 123,\n \"amount\": 123,\n \"comment\": \"<string>\",\n \"currency\": \"<string>\",\n \"properties\": {}\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Content-Type", "application/json-patch+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://api.example.com/v3/rewards")
.header("Content-Type", "application/json-patch+json")
.body("{\n \"partnerId\": 123,\n \"amount\": 123,\n \"comment\": \"<string>\",\n \"currency\": \"<string>\",\n \"properties\": {}\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.example.com/v3/rewards")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Content-Type"] = 'application/json-patch+json'
request.body = "{\n \"partnerId\": 123,\n \"amount\": 123,\n \"comment\": \"<string>\",\n \"currency\": \"<string>\",\n \"properties\": {}\n}"
response = http.request(request)
puts response.read_body{
"id": 123,
"uniqueId": "<string>",
"partnerId": 123,
"dealId": 123,
"status": "Unknown",
"creationDate": "2023-11-07T05:31:56Z",
"amount": {
"value": 123,
"currency": "<string>"
},
"payoutId": 123,
"comment": "<string>",
"rewardType": "Unknown",
"properties": {}
}{
"errorCode": "Transactions.InvalidCustomerIdentifier",
"errorMessage": "You must specify one customer identifier"
}