Skip to content

SEON

Screen card payments with SEON before they're authorised.

SEON screens card payments before Ginger sends them to the processor. Read Fraud prevention first: it explains when the check runs and what happens when SEON declines a payment or doesn't respond.

Before you begin

  • A SEON account and its API key. Use a separate test API key for test orders, if you have one.
  • Access to Platform settings in the Admin portal, and an admin API key or user to update projects with the Boarding API.

Add the integration to your platform

Add SEON

In the Admin portal, go to Platform settings › Risk & Fraud and select Add Integration. Choose SEON, enter the API key and the test API key, and set the status to enabled.

Choose how strict it is

SettingWhat it does
decline_transaction_if_integration_is_unavailableDecline the payment when SEON returns an error or doesn't answer in time. Off: the payment continues without a decision.
report_onlyRun the check and record the result on the transaction, but never decline a payment. Use it to tune your SEON rules on live traffic first.
enable_visa_aml_apiAlso run SEON's AML screening, for Visa account funding and payout transactions.

Configure the project

Set fraud_prevention_integration to seon on every project that SEON should screen. Only an admin can set it: use the admin path of the Boarding API.

curl https://api.example.com/v1/admin/merchants/$MERCHANT_ID/projects/$PROJECT_ID/ \
  --user "$API_KEY:" \
  --header "Content-Type: application/json" \
  --request PUT \
  --data '{
    "trade_name": "Acme Coffee",
    "description": "Acme Coffee webshop",
    "status": "active-production",
    "website_url": "https://www.example.com/",
    "fraud_prevention_integration": "seon"
  }'

An update of the project needs its trade_name, description, status and website_url too. See Update a project in the API reference.

To stop screening a project with SEON, ask your Ginger contact how to clear fraud_prevention_integration on the project.

What Ginger sends to SEON

For each check, Ginger sends the payment details SEON uses to score it: the amount and currency, the card's BIN, last four digits and expiry, the customer's IP address, email address, name and phone number, the billing and delivery address, the order lines, the 3-D Secure result and the device fingerprint. Ginger also sends the merchant ID and name, and the project ID and name as custom fields, so you can build SEON rules per merchant or project.

When a chargeback arrives for a screened payment, Ginger tags the original transaction in SEON, so SEON learns from it.

Next steps