POST /v1/radar/payment_evaluations

Request a Radar API fraud risk score from Stripe for a payment before sending it for external processor authorization.

Servers

Request headers

Name Type Required Description
Content-Type String Yes The media type of the request body.

Default value: "application/x-www-form-urlencoded"

Request body fields

Name Type Required Description
payment_details Object Yes

Details about the payment.

payment_details.money_movement_details Object No
payment_details.money_movement_details.money_movement_type String Yes

Valid values:

  • "card"
payment_details.money_movement_details.card Object No
payment_details.money_movement_details.card.payment_type String No

Valid values:

  • "one_off"
  • "recurring"
  • "setup_recurring"
  • "setup_one_off"
payment_details.money_movement_details.card.customer_presence String No

Valid values:

  • "off_session"
  • "on_session"
payment_details.description String No
payment_details.amount Integer Yes
payment_details.payment_method_details Object Yes
payment_details.payment_method_details.payment_method String Yes
payment_details.payment_method_details.billing_details Object No
payment_details.payment_method_details.billing_details.email String No
payment_details.payment_method_details.billing_details.name String No
payment_details.payment_method_details.billing_details.phone String No
payment_details.payment_method_details.billing_details.address Object No
payment_details.payment_method_details.billing_details.address.line2 String No
payment_details.payment_method_details.billing_details.address.line1 String No
payment_details.payment_method_details.billing_details.address.postal_code String No
payment_details.payment_method_details.billing_details.address.country String No
payment_details.payment_method_details.billing_details.address.state String No
payment_details.payment_method_details.billing_details.address.city String No
payment_details.statement_descriptor String No
payment_details.currency String Yes
payment_details.shipping_details Object No
payment_details.shipping_details.name String No
payment_details.shipping_details.phone String No
payment_details.shipping_details.address Object No
payment_details.shipping_details.address.line2 String No
payment_details.shipping_details.address.line1 String No
payment_details.shipping_details.address.postal_code String No
payment_details.shipping_details.address.country String No
payment_details.shipping_details.address.state String No
payment_details.shipping_details.address.city String No
customer_details Object Yes

Details about the customer associated with the payment evaluation.

customer_details.customer String No
customer_details.email String No
customer_details.name String No
customer_details.phone String No
customer_details.customer_account String No
expand[] Array No

Specifies which fields in the response should be expanded.

metadata Object No

Set of key-value pairs that you can attach to an object. This can be useful for storing additional information about the object in a structured format. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to metadata.

client_device_metadata_details Object No

Details about the Client Device Metadata to associate with the payment evaluation.

client_device_metadata_details.radar_session String Yes

How to start integrating

  1. Add HTTP Task to your workflow definition.
  2. Search for the API you want to integrate with and click on the name.
    • This loads the API reference documentation and prepares the Http request settings.
  3. Click Test request to test run your request to the API and see the API's response.