Get Fraud check by ID

curl --request GET \
  --url https://api.staging.payrails.io/payment/frauds/{fraudId} \
  --header 'Authorization: Bearer <token>'

const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

fetch('https://api.staging.payrails.io/payment/frauds/{fraudId}', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.staging.payrails.io/payment/frauds/{fraudId}",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://api.staging.payrails.io/payment/frauds/{fraudId}"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("Authorization", "Bearer <token>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

require 'uri'
require 'net/http'

url = URI("https://api.staging.payrails.io/payment/frauds/{fraudId}")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'

response = http.request(request)
puts response.read_body

{
  "id": "f136fe25-04db-4a64-8a93-5b8b3f97c35b",
  "createdAt": "2022-04-22T17:53:36.814Z",
  "updatedAt": "2022-04-22T17:53:48.273Z",
  "status": "Scored",
  "merchantReference": "order_12345",
  "holderId": "bf212dd3-854f-4e8a-a7a6-3bddfe20dbe2",
  "decision": "Allow",
  "workflowExecutionId": "payment-acceptance/6aa0ac3b-df9b-4ac4-95ae-590fc5028c48",
  "workflowExecutionActionId": "6aa0ac3b-df9b-4ac4-95ae-590fc5028c48",
  "providerId": "b401b73d-3ca0-4639-9b6a-d7a68f3c36c8",
  "providerConfigId": "d7872d9d-88b4-44be-a929-ba90e208c9c5",
  "providerName": "cybersource",
  "providerDisplayName": "Cybersource",
  "providerReference": "7259709193376209003955",
  "providerAccountDisplayName": "Cybersource DE",
  "instrumentId": "e017f2e8-ab46-4eca-ad21-eee3f945fb07",
  "instrumentTokenId": "38fa0ee2-3f6e-41c1-8298-7398b2a93bd3",
  "workspaceId": "7f9f1882-a103-408d-ac96-46a7021e537a",
  "amount": {
    "value": "10.00",
    "currency": "EUR"
  },
  "lastOperationResult": "Success",
  "meta": {
    "risk": {
      "allowNative3DS": false,
      "merchantDefinedData": {
        "yourKey": "yourValue"
      }
    },
    "source": "mobile",
    "customer": {
      "name": "John",
      "lastName": "Doe",
      "email": "john.doe@payrails.com",
      "reference": "tp_10518af2-48c4-41aa-a3f2-4bb4e9086ec5"
    },
    "billingAddress": {
      "city": "Berlin",
      "country": {
        "code": "DE"
      },
      "postalCode": "10405",
      "street": "Straßburger Straße",
      "doorNumber": "1"
    },
    "order": {
      "total": {
        "value": "22",
        "currency": "USD"
      },
      "deliveryAddress": {
        "city": "Berlin",
        "country": {
          "code": "DE"
        },
        "postalCode": "10405",
        "street": "Straßburger Straße",
        "doorNumber": "1",
        "email": "review@visa.com"
      },
      "billingAddress": {
        "city": "Berlin",
        "country": {
          "code": "DE"
        },
        "postalCode": "10405",
        "street": "Straßburger Straße",
        "doorNumber": "1",
        "email": "review@visa.com",
        "name": "Joe",
        "lastName": "David"
      },
      "lines": [
        {
          "id": "3f233c69-5b1a-4794-b8d9-87212e45ab23",
          "quantity": 1,
          "name": "0c144eb3-4a09-410e-a23e-0875e6f56e47",
          "unitPrice": {
            "value": "22",
            "currency": "USD"
          }
        }
      ],
      "clientContext": {
        "ipAddress": "217.110.239.132",
        "osType": "web",
        "userAgent": "Mozilla/5.0 (Macintosh; Intel Mac OS X 10_15_7) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/114.0.0.0 Safari/537.36",
        "acceptHeader": "text/html,application/xhtml+xml,application/xml;q=0.9,image/webp,image/apng,*/*;q=0.8",
        "language": "en-US",
        "colorDepth": 24,
        "screenHeight": 723,
        "screenWidth": 1536,
        "timeZoneOffset": 0,
        "javaEnabled": false,
        "javaScriptEnabled": false
      }
    }
  },
  "instrument": {
    "id": "15b0069a-913b-4224-b05a-056e89611a51",
    "holderId": "788c7c09-a490-4603-915a-e2a957a6cca1",
    "createdAt": "2022-04-22T17:53:36.814Z",
    "updatedAt": "2022-04-22T17:53:36.814Z",
    "paymentMethod": "card",
    "description": "Personal card.",
    "fingerprint": "739abff0-406a-4d32-8cfb-701e12be5848",
    "status": "created",
    "futureUsage": "CardOnFile",
    "data": {
      "network": "visa",
      "bin": "411111",
      "suffix": "1111",
      "expiryMonth": "10",
      "expiryYear": "2026",
      "holderName": "John Doe"
    }
  }
}

GET

https://api.staging.payrails.io

payment

frauds

{fraudId}

Get Fraud check by ID

curl --request GET \
  --url https://api.staging.payrails.io/payment/frauds/{fraudId} \
  --header 'Authorization: Bearer <token>'

const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

fetch('https://api.staging.payrails.io/payment/frauds/{fraudId}', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.staging.payrails.io/payment/frauds/{fraudId}",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://api.staging.payrails.io/payment/frauds/{fraudId}"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("Authorization", "Bearer <token>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

require 'uri'
require 'net/http'

url = URI("https://api.staging.payrails.io/payment/frauds/{fraudId}")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'

response = http.request(request)
puts response.read_body

{
  "id": "f136fe25-04db-4a64-8a93-5b8b3f97c35b",
  "createdAt": "2022-04-22T17:53:36.814Z",
  "updatedAt": "2022-04-22T17:53:48.273Z",
  "status": "Scored",
  "merchantReference": "order_12345",
  "holderId": "bf212dd3-854f-4e8a-a7a6-3bddfe20dbe2",
  "decision": "Allow",
  "workflowExecutionId": "payment-acceptance/6aa0ac3b-df9b-4ac4-95ae-590fc5028c48",
  "workflowExecutionActionId": "6aa0ac3b-df9b-4ac4-95ae-590fc5028c48",
  "providerId": "b401b73d-3ca0-4639-9b6a-d7a68f3c36c8",
  "providerConfigId": "d7872d9d-88b4-44be-a929-ba90e208c9c5",
  "providerName": "cybersource",
  "providerDisplayName": "Cybersource",
  "providerReference": "7259709193376209003955",
  "providerAccountDisplayName": "Cybersource DE",
  "instrumentId": "e017f2e8-ab46-4eca-ad21-eee3f945fb07",
  "instrumentTokenId": "38fa0ee2-3f6e-41c1-8298-7398b2a93bd3",
  "workspaceId": "7f9f1882-a103-408d-ac96-46a7021e537a",
  "amount": {
    "value": "10.00",
    "currency": "EUR"
  },
  "lastOperationResult": "Success",
  "meta": {
    "risk": {
      "allowNative3DS": false,
      "merchantDefinedData": {
        "yourKey": "yourValue"
      }
    },
    "source": "mobile",
    "customer": {
      "name": "John",
      "lastName": "Doe",
      "email": "john.doe@payrails.com",
      "reference": "tp_10518af2-48c4-41aa-a3f2-4bb4e9086ec5"
    },
    "billingAddress": {
      "city": "Berlin",
      "country": {
        "code": "DE"
      },
      "postalCode": "10405",
      "street": "Straßburger Straße",
      "doorNumber": "1"
    },
    "order": {
      "total": {
        "value": "22",
        "currency": "USD"
      },
      "deliveryAddress": {
        "city": "Berlin",
        "country": {
          "code": "DE"
        },
        "postalCode": "10405",
        "street": "Straßburger Straße",
        "doorNumber": "1",
        "email": "review@visa.com"
      },
      "billingAddress": {
        "city": "Berlin",
        "country": {
          "code": "DE"
        },
        "postalCode": "10405",
        "street": "Straßburger Straße",
        "doorNumber": "1",
        "email": "review@visa.com",
        "name": "Joe",
        "lastName": "David"
      },
      "lines": [
        {
          "id": "3f233c69-5b1a-4794-b8d9-87212e45ab23",
          "quantity": 1,
          "name": "0c144eb3-4a09-410e-a23e-0875e6f56e47",
          "unitPrice": {
            "value": "22",
            "currency": "USD"
          }
        }
      ],
      "clientContext": {
        "ipAddress": "217.110.239.132",
        "osType": "web",
        "userAgent": "Mozilla/5.0 (Macintosh; Intel Mac OS X 10_15_7) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/114.0.0.0 Safari/537.36",
        "acceptHeader": "text/html,application/xhtml+xml,application/xml;q=0.9,image/webp,image/apng,*/*;q=0.8",
        "language": "en-US",
        "colorDepth": 24,
        "screenHeight": 723,
        "screenWidth": 1536,
        "timeZoneOffset": 0,
        "javaEnabled": false,
        "javaScriptEnabled": false
      }
    }
  },
  "instrument": {
    "id": "15b0069a-913b-4224-b05a-056e89611a51",
    "holderId": "788c7c09-a490-4603-915a-e2a957a6cca1",
    "createdAt": "2022-04-22T17:53:36.814Z",
    "updatedAt": "2022-04-22T17:53:36.814Z",
    "paymentMethod": "card",
    "description": "Personal card.",
    "fingerprint": "739abff0-406a-4d32-8cfb-701e12be5848",
    "status": "created",
    "futureUsage": "CardOnFile",
    "data": {
      "network": "visa",
      "bin": "411111",
      "suffix": "1111",
      "expiryMonth": "10",
      "expiryYear": "2026",
      "holderName": "John Doe"
    }
  }
}

Authorizations

Authorization

string

header

required

You can use an OAuth2 JWT bearer token in the Authorization header of your API requests for supported endpoints: Authorization: Bearer <YOUR_JWT_HERE>. These tokens are valid for 10 minutes and can be requested via the access token endpoint endpoint.

Path Parameters

fraudId

string<uuid>

required

Identifier of the resource in Payrails.

Query Parameters

includeInstrument

boolean

default:false

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

includeHolderReference

boolean

default:false

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

Response

Fraud check found, and all details are included.

string<uuid>

required

Unique identifier of the Fraud check in Payrails.

createdAt

string<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.

updatedAt

string<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.

status

enum<string>

required

Current status of the Fraud check in Payrails.

Available options:

Created,

ReviewRequired,

Scored,

Pending,

Failed,

Unknown

workflowExecutionId

string

required

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

providerId

string<uuid>

required

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

providerConfigId

string<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.

Payrails API Reference

Get started

Workflow

Payment

Provider

Merchant

Vault

Analytics

Reporting

Reconciliation

Dispute

Get Fraud check by ID

Authorizations

Path Parameters

Query Parameters

Response