Skip to main content
POST
Assess payout / disbursement risk

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.