Sign in

v1

latestOpenAPI 3.0.32026-07-24148824715.6 KB
Payment Screening Configurations

Get a payment screening configuration version

This endpoint returns a version of a payment screening configuration with its metadata.

Payment screening configurations define which lists a transaction will be screened against, and the fuzziness that should be applied to the search. You can create multiple of these in your account. Each payment screening configuration can have multiple versions.

You need "Access to base payment screening functionality" enabled to use this endpoint.

get/v2/payment-screening/configurations/{configuration_identifier}/versions/{version_identifier}

Path parameters

configuration_identifierstring uuid required

configuration ID

version_identifierinteger required

configuration version

Response

OK

change_reasonstring required
configuration_identifierstring uuid required
is_archivedboolean required
updated_atstring date-time required
updated_bystring uuid required
versioninteger required

Example response

{
  "configuration": {
    "source_collections": [
      {
        "name_settings": {
          "name_fuzziness": 0.8
        },
        "reference_text_settings": {
          "reference_text_fuzziness": 0.8
        },
        "source_type": "SANCTION"
      }
    ]
  }
}