Skip to main content
Version: 2.0

Changelog

Version 2.0​

Changes to API endpoints​

  • The Payment Fraud Score endpoint has been renamed to Financial Events Screening to better reflect its purpose of screening financial events rather than just providing a score. The score field in the response continues to represent the fraud risk assessment.
https://api.fraudio.com/v2/financial-events/screening
  • The Payment Events Enrichment endpoint has been renamed to Financial Events Enrichment.
https://api.fraudio.com/v2/financial-events/enrichment

  • Payment Post-Authorization Enrichment is no longer a separate endpoint in v2. Send post-authorization data (for example authorization response fields such as response_code, eci, avs_result, cvv_result, cavv_result) to Financial Events Enrichment as a card_network_transaction event with MTI 0110 (authorization response), linked to the original 0100 via parent_event_id and/or lifecycle_rrn.

  • Merchant Account Information is no longer a separate endpoint in v2. Send merchant and other entity snapshots or updates via Financial Events Enrichment using an entities-only payload (events: []).

  • Merchant entities are renamed: use merchant_business for the selling business, and merchant_account for the acquiring account. The processor-assigned Merchant ID is the mid property on merchant_account (not a separate entity type). Registered MCCs go on merchant_account / sub_merchant (mccs); the as-processed code for a payment goes on the event (card_network_transaction.mcc or wallet_payment.mcc). sub_merchant is a PayFac-sponsored seller.

  • The former event type transaction is renamed to the card_network_transaction payload key (card payment network messages such as authorization, capture, reversal, OCT). Type-specific fields live under the card_network_transaction object (including transaction_type).

  • Events no longer use co-dependent type + details fields. Each event carries exactly one event-type payload key (oneOf), e.g. card_network_transaction: { ... } or dispute: { ... }. Party and intermediary fields (sender, receiver, refs) live inside that payload object, not beside it on the event.

  • Paying a merchant from a wallet (not a card-network purchase) uses the wallet_payment payload on Financial Events Screening. Sender typically refs a wallet and/or bank_account; receiver typically refs a merchant entity. As-processed MCC goes on wallet_payment.mcc.

  • Card entities are split: card_account (PAR / pan_fingerprint) and card (issued plastic/virtual instance). Opaque processor vault or CMS ids use a single card_reference on either entity (account-scoped vs instance-scoped). Legacy card_token / issuer-acquirer split refs map to card_reference. There is no digitized_card; do not send network token (DPAN) values. Keep card_group only as a degraded fallback. Ownership uses refs.cardholders on those entity payloads (array): many holders on an account; one or two embossed names on a plastic. Event-type payload sender.refs.cardholder stays singular for who acted.

  • Each entity in entities is a single-key object (oneOf) whose key is the entity type, e.g. { "card": { "id": "...", "timestamp": ..., ... } }. The nested object includes a timestamp (Unix seconds, may be fractional) for when that entity snapshot was observed or is valid.

  • Events and entities accept an optional labels object: a flat map of client-defined string keys to string values, with no Fraudio-defined key schema. Nested objects, arrays, and non-string values are not allowed.

  • Entities no longer use a co-dependent top-level type field alongside attributes; the entity type is the object key.

  • The Merchant Evaluations endpoint has been removed in v2.

  • Dispute Events is no longer a separate endpoint in v2. Send disputes via Financial Events Enrichment with a dispute payload.

  • Account Bank Transfers is no longer a separate endpoint in v2. Send bank-to-bank transfers via Financial Events Enrichment with a bank_transfer payload.

  • All other endpoints remain functionally similar but now use the v2 API path structure.

Version 1.1​

Attention:

We've updated our API endpoints with new names and an additional route. However: All previous endpoints remain operational and supported, facilitating a seamless transition.

For help navigating the legacy endpoints, please refer to the Version 1.0 documentation or select version 1.0 directly from the top navigation dropdown.

Changes to API endpoints​

  • The "Fraud Score" endpoint has been renamed to Payment Fraud Score.
https://api.fraudio.com/v1/transactions/payment-fraud-score
  • The "Post-Authorization Backfill" endpoint has been renamed to Payment Post-Authorization Enrichment.
https://api.fraudio.com/v1/transactions/payment-post-authorization-enrichment
  • The endpoints "Fraud Notifications Enrichment" and "Chargebacks" are aliases for the new Dispute Events endpoint.
https://api.fraudio.com/v1/transactions/dispute-events
  • The Payment Events Enrichment endpoint is brand-new, and is designed as a supplement to the Payment Fraud Score endpoint, supporting additional data on both pre-auth and post-auth integrations.
https://api.fraudio.com/v1/transactions/payment-events-enrichment
tip

Note on the difference between Payment Events Enrichment and Payment Post-Authorization Enrichment:

  • Payment Events Enrichment supports both pre-auth and post-auth integrations in the context of real-time fraud detection.
  • Payment Post-Authorization Enrichment is all about enriching existing pre-auth transactions with new data, and is specialized for pre-auth setups, letting you backfill post-auth fields like eci and cavvresult, which the first endpoint doesn't accommodate.

Added Rules Management API Endpoints​

We've introduced new API endpoints for Rules Management. These endpoints allow customers to create, read, update, and archive transaction rules. These additions provide more granular control for fraud detection and transaction processing. Please refer to the updated documentation sections on Rules Management for detailed information on each endpoint and its usage.

New and modified fields​

  • The fields originalamount and iban have been renamed in all endpoints where they existed:
    • originalamount is now amount.
    • iban is now bankaccountnumber.
  • currencyunit now allows you to specify the currency unit (minor / major).