XS2A.risk

Complete xs2a.risk by uploading account data to our systems.

This action will complete the started wizard_session and can not be done in testmode.

post/risks/upload/{wizard-session-id}

Path parameters

wizard-session-idstring required

Wizard-session-id which was recieved using POST /risks

Query parameters

format'json' | 'json2' | 'camt'

The format parameter is optional and defines which format you are about to upload. The account snapshot upload function is available in the following formats: json and CAMT. This call defaults to json if the format parameter is omitted. If you are using CAMT format, please insert the whole camt xml code as payload. (no json)

Request body

Example request

[
  {
    "account": {
      "country_id": "DE"
    },
    "balance": {
      "currency": "EUR"
    },
    "turnovers": [
      {
        "currency_id": "EUR"
      }
    ]
  }
]

Response

Requests processed successfully.

idstring

transactionstring

account_holderstring

ibanstring

bicstring

bank_namestring

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

The 2-letter country code

testmodeinteger

created_atstring

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

objectstring

Example response

{
  "id": "xr_dfdsfdf34dsgds09g",
  "transaction": "10001-xr-Hdfh-EWfdas",
  "account_holder": "Tink Germany",
  "iban": "DE8888888888888",
  "bic": "GIXXXXXGI",
  "bank_name": "Bankname",
  "country_id": "DE",
  "testmode": 1,
  "created_at": "2020-01-01 10:00:00",
  "metadata": {
    "key1": "value1"
  },
  "merchant_id": "MerchantID",
  "object": "xs2a_risk"
}

Changes

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