Skip to main content
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
  }
}
'
{
  "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>"
  }
}

Authorizations

Authorization
string
header
default:clm_sk_your_secret_key
required

Partner secret or publishable key, e.g. clm_sk_... or clm_pub_... (assess only).

Body

application/json
amount
number
required
Required range: x >= 0
currency
string
required
Example:

"MXN"

amount_unit
enum<string>
Available options:
major,
minor
amount_minor
number
transaction_type
string
Example:

"payout"

customer_id
string
beneficiary
object
origin
object
payout
object
device
object
metadata
object

Response

Payout assessment completed

decision
enum<string>
Available options:
approve,
review,
challenge,
decline
risk_score
integer
Required range: 0 <= x <= 100
signals
string[]

Codes of the signals that fired.

signal_details
object[]
session_id
string
order_id
string | null
payment_id
string | null
idempotency_key
string | null
blocked_by
string | null

Reason when the transaction was hard-blocked.

latency_ms
integer
assess_flow
enum<string>
Available options:
payin,
payout
flow
string

Present on payout assess responses.

Example:

"payout"

field_warnings
object

Present when recommended segment fields were omitted; assess still succeeds.