Payouts
Create payouts
It creates payouts from rewards matching the specified criteria. If no rewards match the given criteria no payout is created.
Examples:
To create payouts for all partners from all pending rewards within a specific date range:
{ "fromDate": "2022-01-01T00:00:00Z", "toDate": "2022-04-01T00:00:00Z" }
To create payouts for two specific partners:
{ "partnerIds": [21, 42] }
Where 21 and 42 are the partner IDs.
POST
/
v3
/
payouts
Create payouts
curl --request POST \
--url https://api.example.com/v3/payouts \
--header 'Content-Type: application/json-patch+json' \
--data '
{
"partnerIds": [
123
],
"currency": "<string>",
"fromDate": "2023-11-07T05:31:56Z",
"toDate": "2023-11-07T05:31:56Z",
"threshold": 123,
"properties": {}
}
'import requests
url = "https://api.example.com/v3/payouts"
payload = {
"partnerIds": [123],
"currency": "<string>",
"fromDate": "2023-11-07T05:31:56Z",
"toDate": "2023-11-07T05:31:56Z",
"threshold": 123,
"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({
partnerIds: [123],
currency: '<string>',
fromDate: '2023-11-07T05:31:56Z',
toDate: '2023-11-07T05:31:56Z',
threshold: 123,
properties: {}
})
};
fetch('https://api.example.com/v3/payouts', 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/payouts",
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([
'partnerIds' => [
123
],
'currency' => '<string>',
'fromDate' => '2023-11-07T05:31:56Z',
'toDate' => '2023-11-07T05:31:56Z',
'threshold' => 123,
'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/payouts"
payload := strings.NewReader("{\n \"partnerIds\": [\n 123\n ],\n \"currency\": \"<string>\",\n \"fromDate\": \"2023-11-07T05:31:56Z\",\n \"toDate\": \"2023-11-07T05:31:56Z\",\n \"threshold\": 123,\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/payouts")
.header("Content-Type", "application/json-patch+json")
.body("{\n \"partnerIds\": [\n 123\n ],\n \"currency\": \"<string>\",\n \"fromDate\": \"2023-11-07T05:31:56Z\",\n \"toDate\": \"2023-11-07T05:31:56Z\",\n \"threshold\": 123,\n \"properties\": {}\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.example.com/v3/payouts")
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 \"partnerIds\": [\n 123\n ],\n \"currency\": \"<string>\",\n \"fromDate\": \"2023-11-07T05:31:56Z\",\n \"toDate\": \"2023-11-07T05:31:56Z\",\n \"threshold\": 123,\n \"properties\": {}\n}"
response = http.request(request)
puts response.read_body{
"items": [
{
"id": 123,
"partnerId": 123,
"partnerName": "<string>",
"name": "<string>",
"uniqueId": "<string>",
"currency": "<string>",
"rewardType": "Unknown",
"fromDate": "2023-11-07T05:31:56Z",
"toDate": "2023-11-07T05:31:56Z",
"amount": {
"value": 123,
"currency": "<string>"
},
"taxAmount": {
"value": 123,
"currency": "<string>"
},
"grossAmount": {
"value": 123,
"currency": "<string>"
},
"rewardCount": 123,
"creationDate": "2023-11-07T05:31:56Z",
"paidDate": "2023-11-07T05:31:56Z",
"acceptedDate": "2023-11-07T05:31:56Z",
"validatedDate": "2023-11-07T05:31:56Z",
"paidByUserId": 123,
"acceptedByUserId": 123,
"validatedByUserId": 123,
"invalidatedDate": "2023-11-07T05:31:56Z",
"invalidatedByUserId": 123,
"status": "Unknown",
"source": "Unknown",
"shouldValidateRewards": true,
"shouldAttachInvoice": true,
"isSelfInvoice": true,
"properties": {},
"rewards": [
{
"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": {}
}
]
}
],
"paginationSkipCount": 123,
"totalCount": 123
}{
"errorCode": "Transactions.InvalidCustomerIdentifier",
"errorMessage": "You must specify one customer identifier"
}Body
application/json-patch+jsonapplication/jsontext/jsonapplication/*+json
Available options:
Unknown, Cash, Coupon, Credit, GiftCard Available options:
Unknown, Pending, Accepted, Paid, Declined Show child attributes
Show child attributes
Create payouts
curl --request POST \
--url https://api.example.com/v3/payouts \
--header 'Content-Type: application/json-patch+json' \
--data '
{
"partnerIds": [
123
],
"currency": "<string>",
"fromDate": "2023-11-07T05:31:56Z",
"toDate": "2023-11-07T05:31:56Z",
"threshold": 123,
"properties": {}
}
'import requests
url = "https://api.example.com/v3/payouts"
payload = {
"partnerIds": [123],
"currency": "<string>",
"fromDate": "2023-11-07T05:31:56Z",
"toDate": "2023-11-07T05:31:56Z",
"threshold": 123,
"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({
partnerIds: [123],
currency: '<string>',
fromDate: '2023-11-07T05:31:56Z',
toDate: '2023-11-07T05:31:56Z',
threshold: 123,
properties: {}
})
};
fetch('https://api.example.com/v3/payouts', 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/payouts",
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([
'partnerIds' => [
123
],
'currency' => '<string>',
'fromDate' => '2023-11-07T05:31:56Z',
'toDate' => '2023-11-07T05:31:56Z',
'threshold' => 123,
'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/payouts"
payload := strings.NewReader("{\n \"partnerIds\": [\n 123\n ],\n \"currency\": \"<string>\",\n \"fromDate\": \"2023-11-07T05:31:56Z\",\n \"toDate\": \"2023-11-07T05:31:56Z\",\n \"threshold\": 123,\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/payouts")
.header("Content-Type", "application/json-patch+json")
.body("{\n \"partnerIds\": [\n 123\n ],\n \"currency\": \"<string>\",\n \"fromDate\": \"2023-11-07T05:31:56Z\",\n \"toDate\": \"2023-11-07T05:31:56Z\",\n \"threshold\": 123,\n \"properties\": {}\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.example.com/v3/payouts")
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 \"partnerIds\": [\n 123\n ],\n \"currency\": \"<string>\",\n \"fromDate\": \"2023-11-07T05:31:56Z\",\n \"toDate\": \"2023-11-07T05:31:56Z\",\n \"threshold\": 123,\n \"properties\": {}\n}"
response = http.request(request)
puts response.read_body{
"items": [
{
"id": 123,
"partnerId": 123,
"partnerName": "<string>",
"name": "<string>",
"uniqueId": "<string>",
"currency": "<string>",
"rewardType": "Unknown",
"fromDate": "2023-11-07T05:31:56Z",
"toDate": "2023-11-07T05:31:56Z",
"amount": {
"value": 123,
"currency": "<string>"
},
"taxAmount": {
"value": 123,
"currency": "<string>"
},
"grossAmount": {
"value": 123,
"currency": "<string>"
},
"rewardCount": 123,
"creationDate": "2023-11-07T05:31:56Z",
"paidDate": "2023-11-07T05:31:56Z",
"acceptedDate": "2023-11-07T05:31:56Z",
"validatedDate": "2023-11-07T05:31:56Z",
"paidByUserId": 123,
"acceptedByUserId": 123,
"validatedByUserId": 123,
"invalidatedDate": "2023-11-07T05:31:56Z",
"invalidatedByUserId": 123,
"status": "Unknown",
"source": "Unknown",
"shouldValidateRewards": true,
"shouldAttachInvoice": true,
"isSelfInvoice": true,
"properties": {},
"rewards": [
{
"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": {}
}
]
}
],
"paginationSkipCount": 123,
"totalCount": 123
}{
"errorCode": "Transactions.InvalidCustomerIdentifier",
"errorMessage": "You must specify one customer identifier"
}