v1

latestOpenAPI 3.1.0Payrails GmbH2026-07-2614905.7 MB

FraudChecks

Get Fraud check by ID

Find a Fraud check from a given ID.

get/payment/frauds/{fraudId}

Path parameters

fraudIdstring uuid required

Identifier of the resource in Payrails.

Query parameters

includeInstrumentboolean

Boolean indicating if the payment instrument should be included in the response.

includeHolderReferenceboolean

Boolean indicating if the holder reference should be included in the response.

Response

Fraud check found, and all details are included.

idstring uuid required

Unique identifier of the Fraud check in Payrails.

createdAtstring date-time required

Exact date and time when the Fraud check was created in Payrails. Possibly differs slightly from the date in the fraud provider.

updatedAtstring date-time required

Exact date and time when the Fraud check was last updated in Payrails. Possibly differs slightly from the date in the fraud provider.

Current status of the Fraud check in Payrails. More information can be found here.

merchantReferencestring

Merchant-provided reference for the Execution. Commonly, the identifier of the order on the Merchant's system.

holderReferencestring

Merchant-provided reference for the transaction counterparty, i.e. the paying consumer.

holderIdstring uuid

Unique identifier of the Holder in Payrails.

Decision taken by the fraud provider.

workflowExecutionIdstring required

Merchant-specific identifier of the execution. This can be used for searching for the Fraud check later.

workflowExecutionActionIdstring uuid

Identifier of the action in the Workflow that led to this Fraud check.

providerIdstring uuid required

Unique identifier of the Provider that was used to process the Fraud check.

providerConfigIdstring uuid required

Unique identifier of the merchant-specific Provider Configuration that was used to process the Fraud check. This can include the set of credentials used, the merchant account, etc.

providerNamestring

Name of the Provider that was used to process the Fraud check, e.g. Adyen, Checkout, Stripe.

providerDisplayNamestring

Display name of the Provider that was used to process the Fraud check.

providerReferencestring

Unique identifier of the Fraud check in an external system, e.g. Fraud provider.

providerAccountDisplayNamestring

Display name of the Provider Account/Configuration that was used to process the Fraud check.

instrumentIdstring uuid

Unique identifier of the Instrument that was used for the Payment in Payrails.

instrumentTokenIdstring uuid

Unique identifier of the specific Token inside the Instrument used for the Payment in Payrails.

Last operation result.

workspaceIdstring required

Workspace ID that the Fraud check belongs to.

Example response

{
  "merchantReference": "order_15415",
  "instrument": {
    "data": {
      "bin": "416598",
      "binLookup": {
        "bin": "416598"
      }
    }
  },
  "amount": {
    "value": "12.50",
    "currency": "EUR"
  },
  "meta": {
    "order": {
      "storeId": "store-123",
      "reference": "order_3573894940903",
      "placement": {
        "country": {
          "code": "DE"
        },
        "city": "Berlin"
      },
      "deliveryAddress": {
        "city": "Ankeborg",
        "country": {
          "code": "SE"
        },
        "doorNumber": "1",
        "street": "Stargatan",
        "postalCode": "12345",
        "name": "Peter",
        "lastName": "Parker",
        "email": "notbatman@gmail.com"
      },
      "billingAddress": {
        "city": "Ankeborg",
        "country": {
          "code": "SE"
        },
        "doorNumber": "1",
        "street": "Stargatan",
        "postalCode": "12345",
        "name": "Bruno",
        "lastName": "Diaz",
        "email": "iambatman@gmail.com"
      },
      "lines": [
        {
          "id": "123",
          "quantity": 1,
          "taxPercentage": {
            "value": "5"
          },
          "description": "Delicious Beer.",
          "name": "Beer 1",
          "total": {
            "value": "100",
            "currency": "SEK"
          },
          "links": {
            "productUrl": "https://www.amazingmerchant.com/products/1",
            "imageUrl": "https://www.amazingmerchant.com/products/1.jpeg"
          }
        }
      ]
    },
    "customer": {
      "reference": "1231905323475",
      "name": "FirstName",
      "lastName": "LastName",
      "email": "someone@email.com",
      "type": "VIP",
      "country": {
        "code": "SE"
      }
    },
    "clientContext": {
      "ipAddress": "217.110.239.132",
      "osType": "ios",
      "userAgent": "Mozilla/5.0 (Windows NT 10.0; Win64; x64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/70.0.3538.110 Safari/537.36",
      "acceptHeader": "text/html,application/xhtml+xml,application/xml;q=0.9,image/webp,image/apng,*/*;q=0.8",
      "language": "nl_NL",
      "colorDepth": 24,
      "screenHeight": 723,
      "screenWidth": 1536,
      "timeZoneOffset": 0,
      "javaEnabled": true,
      "javaScriptEnabled": true,
      "cookiesAccepted": true,
      "origin": "https://merchant.com/checkout",
      "host": "merchant.com"
    },
    "vendor": {
      "reference": "vendor-123",
      "name": "Cool Restaurant"
    },
    "risk": {
      "score": "80",
      "skipPaymentProviderRules": false,
      "force3DS": true,
      "threeDSMode": "Default",
      "allowNative3DS": true,
      "sessionId": "34567890123",
      "exemptionIndicator": "lowValue"
    },
    "subscription": {
      "chargeFrequency": "P2D",
      "expiration": "2000-09-01"
    },
    "tags": {
      "customKey": "customValue"
    }
  }
}