Skip to main content
POST
finance.payment-return-risk.evaluate

Authorizations

Authorization
string
header
required

API key: sk_live_…

Headers

Idempotency-Key
string
required

Required: this capability has an external effect.

Maximum string length: 255
Pramaan-Max-Price-Micro
string

Optional. The most this request may be priced at, in micro-USD (a whole number above 0). It replaces the capability's own price ceiling for this request, lower or higher. Sources that could cost more are left out; when none is left the answer is 400 with the lowest limit that would work.

Pattern: ^[1-9]\d{0,14}$

Body

application/json
ref
string
required

The ref returned by banking.connection.start.

Pattern: ^(ref_[0-9A-HJKMNP-TV-Z]{26}|rh_[A-Za-z0-9_-]{24,1024})$
endUserRef
string
required

Your identifier for the consenting person; it must match the resource owner.

Required string length: 1 - 256

The person agreed to this check and this use of their data.

amount
object
required

Amount with its currency.

defaultPaymentMethod
enum<string>

Requested bank debit settlement method.

Available options:
same-day-ach,
next-day-ach,
standard-ach,
multiple
userPresent
boolean

Whether the person is present.

recurring
boolean

Whether this is a recurring payment.

device
object

Device information used for this check.

include
string[]

Additional requested data.

Maximum array length: 1

Optional attribute section.

Allowed value: "attributes"

Response

The result

scale
object
required

Native score scale; scores from different models cannot be compared.

warnings
enum<string>[]
required

Warnings about missing or stale data.

Maximum array length: 100

Fixed warning code; upstream messages are never returned.

Available options:
reconnect-required,
data-unavailable,
other
customerInitiatedReturnRisk
object

Transaction return risk.

bankInitiatedReturnRisk
object

Transaction return risk.

outcome
enum<string>

Configured rule outcome.

Available options:
accept,
reroute,
review
attributes
object

Documented transaction risk attributes.

ref
string

Reference to what this call created. Pass it as ref to follow-up calls for this resource.