Fetch eliminated processor list

Determines which processors should be eliminated from routing consideration based on historical performance data.

POST /elimination.EliminationAnalyser/GetEliminationStatus

Try it

Fetch eliminated processor list

cURL

curl --request POST \
  --url https://api.example.com/elimination.EliminationAnalyser/GetEliminationStatus \
  --header 'Content-Type: application/json' \
  --header 'x-api-key: <x-api-key>' \
  --header 'x-profile-id: <x-profile-id>' \
  --header 'x-tenant-id: <x-tenant-id>' \
  --data '
{
  "id": "merchant1",
  "labels": [
    "stripe",
    "adyen"
  ],
  "config": {
    "bucket_size": 5,
    "bucket_leak_interval_in_secs": 300
  },
  "params": "card"
}
'

200

{
  "labelsWithStatus": [
    {
      "label": "stripe",
      "eliminationInformation": {
        "entity": {
          "isEliminated": true,
          "bucketName": [
            "processor_decline"
          ]
        },
        "global": {
          "isEliminated": true,
          "bucketName": [
            "processor_decline"
          ]
        }
      }
    }
  ]
}

Headers

x-tenant-id · string · required

x-profile-id · string · required

x-api-key · string · required

Body

application/json

id · string · required

Entity identifier

Example:

"merchant1"

labels · string[] · required

Labels (processors) to check for elimination

Example:

["stripe", "adyen"]

config · object · required

Show child attributes

config. bucket_size · integer<uint64> · required

Maximum failures allowed before elimination

Example:

5

config. bucket_leak_interval_in_secs · number<uint64> · required

Time interval after which failures are "forgotten"

Example:

300

params · string

Additional parameters for elimination analysis

Example:

"card"

Response

200

application/json

Returns a eliminated processor list

labels_with_status · object[]

Elimination status for each label

Show child attributes

labels_with_status. label · string

Example:

"stripe"

labels_with_status. elimination_information · object[]

Show child attributes

labels_with_status.elimination_information. entity · object

Show child attributes

labels_with_status.elimination_information.entity. is_eliminated · boolean

Whether the processor should be eliminated

Example:

true

labels_with_status.elimination_information.entity. bucket_name · string[]

Bucket identifiers that triggered elimination

labels_with_status.elimination_information. global · object

Show child attributes

labels_with_status.elimination_information.global. is_eliminated · boolean

Whether the processor should be eliminated

Example:

true

labels_with_status.elimination_information.global. bucket_name · string[]

Bucket identifiers that triggered elimination