Payout
Assess payout / disbursement risk
Scores an outbound transfer before execution. Requires secret key (clm_sk_*) with assess permission. Response includes flow: "payout" and standard decision fields.
POST
/
api
/
v1
/
assess
/
payout
Assess payout / disbursement risk
curl --request POST \
--url https://sandbox.clausum.ai/api/v1/assess/payout \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"amount": 2500,
"amount_unit": "major",
"currency": "MXN",
"beneficiary": {
"id": "ben_123",
"name": "Vendor SA",
"country": "MX",
"clabe": "012180001234567890"
},
"origin": {
"account_id": "acct_01",
"country": "MX"
},
"payout": {
"channel": "api",
"initiated_by": "treasury@company.com",
"first_to_beneficiary": false
}
}
'import requests
url = "https://sandbox.clausum.ai/api/v1/assess/payout"
payload = {
"amount": 2500,
"amount_unit": "major",
"currency": "MXN",
"beneficiary": {
"id": "ben_123",
"name": "Vendor SA",
"country": "MX",
"clabe": "012180001234567890"
},
"origin": {
"account_id": "acct_01",
"country": "MX"
},
"payout": {
"channel": "api",
"initiated_by": "treasury@company.com",
"first_to_beneficiary": 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({
amount: 2500,
amount_unit: 'major',
currency: 'MXN',
beneficiary: {id: 'ben_123', name: 'Vendor SA', country: 'MX', clabe: '012180001234567890'},
origin: {account_id: 'acct_01', country: 'MX'},
payout: {
channel: 'api',
initiated_by: 'treasury@company.com',
first_to_beneficiary: false
}
})
};
fetch('https://sandbox.clausum.ai/api/v1/assess/payout', 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://sandbox.clausum.ai/api/v1/assess/payout",
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([
'amount' => 2500,
'amount_unit' => 'major',
'currency' => 'MXN',
'beneficiary' => [
'id' => 'ben_123',
'name' => 'Vendor SA',
'country' => 'MX',
'clabe' => '012180001234567890'
],
'origin' => [
'account_id' => 'acct_01',
'country' => 'MX'
],
'payout' => [
'channel' => 'api',
'initiated_by' => 'treasury@company.com',
'first_to_beneficiary' => 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://sandbox.clausum.ai/api/v1/assess/payout"
payload := strings.NewReader("{\n \"amount\": 2500,\n \"amount_unit\": \"major\",\n \"currency\": \"MXN\",\n \"beneficiary\": {\n \"id\": \"ben_123\",\n \"name\": \"Vendor SA\",\n \"country\": \"MX\",\n \"clabe\": \"012180001234567890\"\n },\n \"origin\": {\n \"account_id\": \"acct_01\",\n \"country\": \"MX\"\n },\n \"payout\": {\n \"channel\": \"api\",\n \"initiated_by\": \"treasury@company.com\",\n \"first_to_beneficiary\": false\n }\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://sandbox.clausum.ai/api/v1/assess/payout")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"amount\": 2500,\n \"amount_unit\": \"major\",\n \"currency\": \"MXN\",\n \"beneficiary\": {\n \"id\": \"ben_123\",\n \"name\": \"Vendor SA\",\n \"country\": \"MX\",\n \"clabe\": \"012180001234567890\"\n },\n \"origin\": {\n \"account_id\": \"acct_01\",\n \"country\": \"MX\"\n },\n \"payout\": {\n \"channel\": \"api\",\n \"initiated_by\": \"treasury@company.com\",\n \"first_to_beneficiary\": false\n }\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://sandbox.clausum.ai/api/v1/assess/payout")
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 \"amount\": 2500,\n \"amount_unit\": \"major\",\n \"currency\": \"MXN\",\n \"beneficiary\": {\n \"id\": \"ben_123\",\n \"name\": \"Vendor SA\",\n \"country\": \"MX\",\n \"clabe\": \"012180001234567890\"\n },\n \"origin\": {\n \"account_id\": \"acct_01\",\n \"country\": \"MX\"\n },\n \"payout\": {\n \"channel\": \"api\",\n \"initiated_by\": \"treasury@company.com\",\n \"first_to_beneficiary\": false\n }\n}"
response = http.request(request)
puts response.read_body{
"risk_score": 50,
"signals": [
"<string>"
],
"signal_details": [
{
"code": "<string>",
"weight": 123,
"description": "<string>"
}
],
"session_id": "<string>",
"order_id": "<string>",
"payment_id": "<string>",
"idempotency_key": "<string>",
"blocked_by": "<string>",
"latency_ms": 123,
"flow": "payout",
"field_warnings": {
"missing_recommended": [
"<string>"
],
"field_requirements_doc": "<string>"
}
}{
"error": "<string>"
}{
"error": "<string>"
}{
"error": "<string>"
}{
"error": {
"code": "ASSESS_MAINTENANCE",
"message": "Assess temporarily unavailable"
}
}{
"error": {
"code": "ASSESS_TIMEOUT",
"message": "Assess timed out — retry with same idempotency key"
}
}Authorizations
Partner secret or publishable key, e.g. clm_sk_... or clm_pub_... (assess only).
Body
application/json
Required range:
x >= 0Example:
"MXN"
Available options:
major, minor Example:
"payout"
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Response
Payout assessment completed
Available options:
approve, review, challenge, decline Required range:
0 <= x <= 100Codes of the signals that fired.
Show child attributes
Show child attributes
Reason when the transaction was hard-blocked.
Available options:
payin, payout Present on payout assess responses.
Example:
"payout"
Present when recommended segment fields were omitted; assess still succeeds.
Show child attributes
Show child attributes
⌘I
Assess payout / disbursement risk
curl --request POST \
--url https://sandbox.clausum.ai/api/v1/assess/payout \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"amount": 2500,
"amount_unit": "major",
"currency": "MXN",
"beneficiary": {
"id": "ben_123",
"name": "Vendor SA",
"country": "MX",
"clabe": "012180001234567890"
},
"origin": {
"account_id": "acct_01",
"country": "MX"
},
"payout": {
"channel": "api",
"initiated_by": "treasury@company.com",
"first_to_beneficiary": false
}
}
'import requests
url = "https://sandbox.clausum.ai/api/v1/assess/payout"
payload = {
"amount": 2500,
"amount_unit": "major",
"currency": "MXN",
"beneficiary": {
"id": "ben_123",
"name": "Vendor SA",
"country": "MX",
"clabe": "012180001234567890"
},
"origin": {
"account_id": "acct_01",
"country": "MX"
},
"payout": {
"channel": "api",
"initiated_by": "treasury@company.com",
"first_to_beneficiary": 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({
amount: 2500,
amount_unit: 'major',
currency: 'MXN',
beneficiary: {id: 'ben_123', name: 'Vendor SA', country: 'MX', clabe: '012180001234567890'},
origin: {account_id: 'acct_01', country: 'MX'},
payout: {
channel: 'api',
initiated_by: 'treasury@company.com',
first_to_beneficiary: false
}
})
};
fetch('https://sandbox.clausum.ai/api/v1/assess/payout', 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://sandbox.clausum.ai/api/v1/assess/payout",
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([
'amount' => 2500,
'amount_unit' => 'major',
'currency' => 'MXN',
'beneficiary' => [
'id' => 'ben_123',
'name' => 'Vendor SA',
'country' => 'MX',
'clabe' => '012180001234567890'
],
'origin' => [
'account_id' => 'acct_01',
'country' => 'MX'
],
'payout' => [
'channel' => 'api',
'initiated_by' => 'treasury@company.com',
'first_to_beneficiary' => 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://sandbox.clausum.ai/api/v1/assess/payout"
payload := strings.NewReader("{\n \"amount\": 2500,\n \"amount_unit\": \"major\",\n \"currency\": \"MXN\",\n \"beneficiary\": {\n \"id\": \"ben_123\",\n \"name\": \"Vendor SA\",\n \"country\": \"MX\",\n \"clabe\": \"012180001234567890\"\n },\n \"origin\": {\n \"account_id\": \"acct_01\",\n \"country\": \"MX\"\n },\n \"payout\": {\n \"channel\": \"api\",\n \"initiated_by\": \"treasury@company.com\",\n \"first_to_beneficiary\": false\n }\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://sandbox.clausum.ai/api/v1/assess/payout")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"amount\": 2500,\n \"amount_unit\": \"major\",\n \"currency\": \"MXN\",\n \"beneficiary\": {\n \"id\": \"ben_123\",\n \"name\": \"Vendor SA\",\n \"country\": \"MX\",\n \"clabe\": \"012180001234567890\"\n },\n \"origin\": {\n \"account_id\": \"acct_01\",\n \"country\": \"MX\"\n },\n \"payout\": {\n \"channel\": \"api\",\n \"initiated_by\": \"treasury@company.com\",\n \"first_to_beneficiary\": false\n }\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://sandbox.clausum.ai/api/v1/assess/payout")
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 \"amount\": 2500,\n \"amount_unit\": \"major\",\n \"currency\": \"MXN\",\n \"beneficiary\": {\n \"id\": \"ben_123\",\n \"name\": \"Vendor SA\",\n \"country\": \"MX\",\n \"clabe\": \"012180001234567890\"\n },\n \"origin\": {\n \"account_id\": \"acct_01\",\n \"country\": \"MX\"\n },\n \"payout\": {\n \"channel\": \"api\",\n \"initiated_by\": \"treasury@company.com\",\n \"first_to_beneficiary\": false\n }\n}"
response = http.request(request)
puts response.read_body{
"risk_score": 50,
"signals": [
"<string>"
],
"signal_details": [
{
"code": "<string>",
"weight": 123,
"description": "<string>"
}
],
"session_id": "<string>",
"order_id": "<string>",
"payment_id": "<string>",
"idempotency_key": "<string>",
"blocked_by": "<string>",
"latency_ms": 123,
"flow": "payout",
"field_warnings": {
"missing_recommended": [
"<string>"
],
"field_requirements_doc": "<string>"
}
}{
"error": "<string>"
}{
"error": "<string>"
}{
"error": "<string>"
}{
"error": {
"code": "ASSESS_MAINTENANCE",
"message": "Assess temporarily unavailable"
}
}{
"error": {
"code": "ASSESS_TIMEOUT",
"message": "Assess timed out — retry with same idempotency key"
}
}