Payouts
Prévia do ciclo de payouts: quem recebe, quanto e bloqueios ativos
Simula o fechamento do ciclo de payouts sem agendar nada: lista afiliados elegíveis, valores, afiliados bloqueados (com motivo) e totais consolidados. Por ser apenas uma simulação, não altera nada nem emite eventos.
POST
/
payouts
/
preview
Prévia do ciclo de payouts: quem recebe, quanto e bloqueios ativos
curl --request POST \
--url https://api.userepass.com/payouts/preview \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '{}'import requests
url = "https://api.userepass.com/payouts/preview"
payload = {}
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({})
};
fetch('https://api.userepass.com/payouts/preview', 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.userepass.com/payouts/preview",
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([
]),
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://api.userepass.com/payouts/preview"
payload := strings.NewReader("{}")
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://api.userepass.com/payouts/preview")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.userepass.com/payouts/preview")
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 = "{}"
response = http.request(request)
puts response.read_body{
"eligible": [
{
"affiliateId": "aff_01J9Z3K8N2QF4T7B9XP0WMD5RC",
"affiliateName": "Maria Silva",
"method": "pix",
"amountCents": 25000,
"commissionCount": 4,
"destination": {
"method": "pix",
"pixKey": "[email protected]",
"pixKeyType": "email"
}
}
],
"blocked": [
{
"affiliateId": "aff_01J9Z3K8N2QF4T7B9XP0WMD5RC",
"affiliateName": "João Souza",
"reason": "incomplete_payout_profile",
"amountCents": 25000,
"commissionCount": 4
}
],
"totals": {
"eligibleAmountCents": 100000,
"eligibleCount": 12,
"blockedCount": 3
}
}Authorizations
bearerAuthapiKeyAuth
Chave de API (prefixo rstr_) enviada como Authorization: Bearer rstr_....
Body
application/json
Filtro opcional: restringe a simulação aos afiliados de um programa específico.
Pattern:
^prog_[0-9A-HJKMNP-TV-Z]{26}$Example:
"prog_01J9Z3K8N2QF4T7B9XP0WMD5RC"
Response
200 - application/json
Default Response
⌘I
Prévia do ciclo de payouts: quem recebe, quanto e bloqueios ativos
curl --request POST \
--url https://api.userepass.com/payouts/preview \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '{}'import requests
url = "https://api.userepass.com/payouts/preview"
payload = {}
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({})
};
fetch('https://api.userepass.com/payouts/preview', 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.userepass.com/payouts/preview",
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([
]),
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://api.userepass.com/payouts/preview"
payload := strings.NewReader("{}")
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://api.userepass.com/payouts/preview")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.userepass.com/payouts/preview")
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 = "{}"
response = http.request(request)
puts response.read_body{
"eligible": [
{
"affiliateId": "aff_01J9Z3K8N2QF4T7B9XP0WMD5RC",
"affiliateName": "Maria Silva",
"method": "pix",
"amountCents": 25000,
"commissionCount": 4,
"destination": {
"method": "pix",
"pixKey": "[email protected]",
"pixKeyType": "email"
}
}
],
"blocked": [
{
"affiliateId": "aff_01J9Z3K8N2QF4T7B9XP0WMD5RC",
"affiliateName": "João Souza",
"reason": "incomplete_payout_profile",
"amountCents": 25000,
"commissionCount": 4
}
],
"totals": {
"eligibleAmountCents": 100000,
"eligibleCount": 12,
"blockedCount": 3
}
}