Sign in
XS2A.risk

Get a xs2a.risk transaction object

Please Note: In the following documentation, all available risk checks are included in the response body. Note however, that only the ones which you requested will be included in the response, and that 'xs2a_account_snapshot' have its own endpoint, where you will get the full results of this check.

get/risks/{transaction-id}

Path parameters

transaction-idstring required

ID of the transaction to be retrieved.

Response

Request successfully processed

idstring

Transaction id

transactionstring

Internal XS2A transaction id. This id will be the same for the whole transaction

account_holderstring

Account holder name

ibanstring

IBAN

bicstring

BIC

bank_namestring

Bank name

country_id'DE' | 'AT' | 'CH'

The 2-letter country code

testmodestring

Indicates whether or not it is a test transaction

created_atstring

Date of creation

metadataMetadata nullable

An array of data which will be passed back to your application. With this field you can for example pass information about your customer ids, order ids and the like back to your application. Please beware of some restrictions for the metadata field: maximum of 3 values, maximum of a key length of 20 characters, maximum length of values is 128 characters. For privacy protection reason it is not allowed to use this field for transferring personal data (e.g. names or addresses).

merchant_idstring

Data will be returned unchanged

objectstring

Object type, in this case a xs2a_risk

Example response

{
  "id": "xr_hd84kg9zns53lvh1",
  "transaction": "10001-xr-abcd-abcd",
  "account_holder": "MUSTERMANN, HARTMUT",
  "iban": "DE62888888880012345678",
  "bic": "TESTDE88XXX",
  "bank_name": "Testbank",
  "country_id": "DE",
  "testmode": "1",
  "created_at": "2015-05-05 11:47:45",
  "metadata": {
    "key1": "value1"
  },
  "object": "xs2a_risk",
  "xs2a_account_snapshot": {
    "object": "xs2a_account_snapshot",
    "days": 45,
    "from": "0000-12-27",
    "to": "0000-12-30",
    "filters": [
      "rent, income"
    ],
    "all_tags": "1",
    "created_at": "2014-03-23 15:55:54"
  },
  "xs2a_age_verification_check": {
    "confirmed": true,
    "created_at": "2014-03-23 15:55:54",
    "object": "xs2a_age_verification_check"
  },
  "xs2a_balance_check": {
    "object": "xs2a_balance_check",
    "check_amount": 100,
    "check_currency_id": "EUR",
    "check_passed": "1",
    "created_at": "2014-03-23 15:55:54"
  },
  "xs2a_balance_overview": {
    "object": "xs2a_balance_overview",
    "balance": 135.99,
    "available": 1135.99,
    "limit": 1000.99,
    "currency_id": "EUR",
    "created_at": "2014-03-23 15:55:54"
  },
  "xs2a_cashflow_overview": {
    "created_at": "2014-03-23 15:55:54",
    "object": "xs2a_cashflow_overview",
    "cashflow": [
      {
        "incoming": 543.25,
        "outgoing": 234.21,
        "minimum_balance": 135.52,
        "currency_id": "EUR"
      }
    ]
  },
  "xs2a_chargeback_check": {
    "chargebacks_count": 2,
    "chargebacks_coverage": 1,
    "chargebacks_revoked": 1,
    "chargebacks_sum_amount": 43.2,
    "currency_id": "EUR",
    "object": "xs2a_chargeback_check",
    "created_at": "2014-03-23 15:55:54"
  },
  "xs2a_risk_insurance_contract_check": {
    "result": {
      "category_id": "K.8.1.1.2",
      "counter_holder": "Max Mustermann",
      "insurance_policy_number": [
        "111111-V"
      ],
      "count": 1,
      "meta_data": []
    }
  },
  "xs2a_profit_loss_check": {
    "result": {
      "tax_ids": [
        "123/456/7890"
      ],
      "profit_loss": {
        "period_start": "2019-02-01",
        "period_end": "2019-04-30",
        "period_days": 90,
        "turnover_income": 2452.23,
        "cash_deposit": 123.55,
        "other_income": 2456.23,
        "rent_expense": 256.56,
        "supplies_expense": 4535.82,
        "personnel_expense": 45345.12,
        "tax_expense": 43534.63,
        "other_expense": 34234.25,
        "cashflow": 3434324234.52,
        "cashflow_revenue_ratio": 0.12
      }
    }
  },
  "xs2a_income_check": {
    "data": {
      "full_months_count": 2,
      "category_short_name": {
        "monthly_sums": {
          "2020-09": 3124.29
        },
        "months_sums_median": 234.25,
        "months_sums_minimum": 123.62,
        "min_date": "2019-02-01",
        "max_date": "2019-05-01",
        "current_payment": true,
        "forecast": 786.25,
        "forecast_month_count": 3,
        "current_employers": 3,
        "employer": {
          "name": "Tink Germany GmbH",
          "months_with_salaries_count": 3,
          "booking_date_first_salary": "2020-07-23",
          "booking_date_last_salary": "2020-09-18",
          "months_sums_median": 255,
          "months_sums_minimum": 189
        }
      }
    },
    "created_at": "2030-03-23 15:55:54"
  },
  "xs2a_account_linked_offers_check": {
    "links": [
      {
        "link": "https://xs2a.com/ad/adl_Erab3azqBjyTtm5d/alo_BAuSoMgqt0vgGuuS",
        "description": "FinTecSystem GmbH",
        "image": "base64"
      }
    ]
  },
  "xs2a_credit_check": {
    "checks": [
      "income, credit"
    ],
    "check_days": 30,
    "results": {
      "income": {
        "amount": 3124.29,
        "currency": "EUR"
      },
      "rent": {
        "amount": 3124.29,
        "currency": "EUR"
      }
    },
    "object": "xs2a_credit_check",
    "created_at": "2014-03-23 15:55:54"
  },
  "xs2a_direct_debit_check": {
    "check_amount": 123.99,
    "check_currency_id": "EUR",
    "start_date": "2014-03-23",
    "end_date": "2014-03-31",
    "recommendation": "DATE",
    "recommendation_date": "2014-03-25",
    "object": "xs2a_direct_debit_check",
    "created_at": "2014-03-23 15:55:54"
  },
  "xs2a_fact_sheet_lists": {
    "fields": [
      {
        "name": "test",
        "tags": [
          "expenditure",
          "banking-fees"
        ],
        "categories": [
          "K.8.2.1"
        ],
        "min_amount": -20,
        "max_amount": -2
      }
    ],
    "days": 180,
    "result": [
      {
        "fields": {
          "name": "test",
          "categories": [
            "K.8.2.1"
          ],
          "tags": [
            "expenditure",
            "banking-fees"
          ],
          "min_amount": -20,
          "max_amount": -2
        },
        "turnovers_count": 57,
        "sum_amounts": -481.81,
        "timespan": 1,
        "distinct_counter_holders": 14,
        "turnovers": 57
      }
    ],
    "created_at": "2020-02-13 14:21:25",
    "object": "xs2a_fact_sheet_lists"
  },
  "xs2a_name_check": {
    "match": "0",
    "similarity": 50,
    "created_at": "2021-08-11 13:10:36",
    "object": "xs2a_name_check"
  },
  "xs2a_overdraft_limit_check": {
    "booking_days": 23,
    "overdraft_limit_days": 23,
    "maximum_overdraft_used": -3760.13,
    "average_overdraft_used": -2032.85,
    "median_overdraft_used": -1466.21,
    "currency_id": "EUR",
    "object": "xs2a_overdraft_limit_check",
    "created_at": "2014-03-23 15:55:54"
  },
  "xs2a_seizure_check": {
    "days": 90,
    "object": "xs2a_seizure_check",
    "created_at": "2014-03-23 15:55:54"
  },
  "xs2a_standing_orders_check": {
    "standing_orders": [
      {
        "sender_account": {
          "holder": "Account Holder",
          "description": "Account description",
          "iban": "DE04888888880087654321",
          "bic": "TESTDE88XXX",
          "country_id": "DE"
        },
        "recipient_account": {
          "holder": "Account Holder",
          "description": "Account description",
          "iban": "DE04888888880087654321",
          "bic": "TESTDE88XXX",
          "country_id": "DE"
        },
        "amount": 500,
        "currency": "EUR",
        "purpose": "Purpose",
        "frequency": "m",
        "frequency_interval": 1,
        "day": 31,
        "start_execution": "2014-11-05"
      }
    ],
    "object": "xs2a_standing_orders",
    "created_at": "2014-03-23 15:55:54"
  },
  "xs2a_all_accounts_check": {
    "accounts": [
      {
        "holder": "Account Holder",
        "description": "Account description",
        "iban": "DE04888888880087654321",
        "bic": "TESTDE88XXX",
        "country_id": "DE"
      }
    ],
    "object": "xs2a_all_accounts_check",
    "created_at": "2014-03-23 15:55:54"
  },
  "xs2a_account_status_check": {
    "account_details": [
      {
        "identifier": "Account Identifier",
        "holder": "MUSTERMANN, HARTMUT",
        "description": "Girokonto",
        "iban": "DE62888888880012345678",
        "bic": "TESTDE88XXX",
        "account_number": "12345678",
        "bank_code": "88888888",
        "bank_name": "Testbank",
        "country_id": "DE",
        "joint_account": "0",
        "account_type": "giro",
        "balance": 2123.25,
        "available": 3123.25,
        "limit": 1000.56,
        "currency_id": "EUR",
        "turnover_days": 90,
        "turnover_available_days": 89,
        "turnover_count": 137,
        "average_account_usage": "1.50",
        "completeness": {
          "counter_holder": "0.86",
          "counter_iban": "0.01",
          "purpose": "1.00"
        },
        "account_data_available": "1"
      }
    ],
    "other_accounts": [
      {
        "holder": "Account Holder",
        "iban": "DE04888888880087654321",
        "bic": "TESTDE88XXX",
        "country_id": "DE",
        "bank_name": "Testbank",
        "type": "giro"
      }
    ],
    "credit_cards": [
      {
        "holder": "Account Holder",
        "iban": "2135*******45643",
        "bic": "CREDIT88XXX",
        "country_id": "DE",
        "bank_name": "Testbank",
        "description": "VISA"
      }
    ],
    "days": 365,
    "all_accounts": "1",
    "created_at": "2014-03-23 15:55:54",
    "object": "xs2a_account_status_check"
  },
  "xs2a_holder_identification_check": {
    "accounts": [
      {
        "type": "giro",
        "holder": "MUSTERMANN, HARTMUT",
        "iban": "DE62888888880012345678",
        "matches": [
          {
            "expected_holder": "Expected Holder",
            "match": "PERSON"
          }
        ]
      }
    ],
    "object": "xs2a_holder_identification_check",
    "created_at": "2014-03-23 15:55:54"
  },
  "xs2a_risk_calculations_check": {
    "calculations": [
      {
        "tags": [
          "transfer"
        ],
        "categories": [
          "K.1.1"
        ],
        "functions": [
          "sum",
          "count",
          "median",
          "average",
          "last",
          "min",
          "max",
          "min_date",
          "max_date",
          "clean_sum",
          "exists",
          "sums_of_every_month",
          "counts_of_every_month",
          "median_of_all_month_sums",
          "average_of_all_month_sums",
          "min_of_all_month_sums",
          "max_of_all_month_sums",
          "distinct_counter_holders"
        ],
        "name": "Example name",
        "days": 180,
        "results": {
          "count": 3
        }
      }
    ],
    "created_at": "2014-03-23 15:55:54",
    "object": "xs2a_risk_calculations_check"
  },
  "xs2a_account_characteristics_check": {
    "chargebacks": {
      "chargebacks_coverage_count": 33,
      "chargebacks_coverage_amount": 400.01,
      "chargebacks_revoke_count": 2,
      "chargebacks_revoke_amount": 20
    },
    "encashment": {
      "collection_count": 12,
      "collection_amount": 2000,
      "collection_office_count": 2
    },
    "account_profile": {
      "cash_withdrawals": 12,
      "cash_deposits": 2,
      "payment_gez": "0",
      "payment_schufa": "0",
      "payment_donation": "1",
      "payment_party": "1",
      "payment_club": "0"
    },
    "loans": {
      "loans_count": 11,
      "loans_amount": 3333.33,
      "subprime_lender_count": 3
    },
    "flags": {
      "gambling": "1",
      "creditcard": "1"
    },
    "object": "xs2a_account_characteristics_check",
    "created_at": "2014-03-23 15:55:54"
  },
  "xs2a_collection_check": {
    "result": {
      "instant_payment": true,
      "monthly_installment": [
        {
          "value": 20,
          "currency_id": "EUR",
          "day_of_month": 1
        }
      ],
      "cash_flow_per_month": [
        {
          "value": 222,
          "currency_id": "EUR",
          "periods": 1
        }
      ],
      "motor_vehicle": true,
      "usable_account": true,
      "debt_collection": [
        {
          "sum": 289.02,
          "payments": 1,
          "currency_id": "EUR",
          "average_per_month": 230.56
        }
      ]
    }
  }
}

Changes

No recorded changes to this endpoint across all 1 revision of this API.