Test Spend Control STIP Rules Evaluation

POST

stip

evaluate

test

{
  "decision": "DECLINE",
  "partialApprovalAmount": {
    "amount": 3.14,
    "currency": "EUR"
  },
  "responseCode": "<string>",
  "details": [
    {
      "ruleSetId": "<string>",
      "operator": "ANY",
      "decision": "DECLINE",
      "entityReferences": [
        {
          "id": "<string>",
          "type": "CARD"
        }
      ],
      "partialApprovalAmount": {
        "amount": 3.14,
        "currency": "EUR"
      },
      "ruleEvaluations": [
        {
          "ruleId": "<string>",
          "decision": "DECLINE",
          "partialApprovalAmount": {
            "amount": 3.14,
            "currency": "EUR"
          },
          "settings": {
            "id": "<string>",
            "ruleType": "DECLINE",
            "name": "<string>",
            "filterOperatorType": "ANY",
            "filters": [
              {
                "id": "<string>",
                "type": "MCC",
                "reversed": true
              }
            ]
          }
        }
      ]
    }
  ]
}

Query Parameters

auditUser

string

required

The audit user to log the request

Body

application/json

cardId

string<biginteger>

required

merchantCategoryCode

string

required

settlementAmount

object

required

Amount including currency

Show child attributes

transactionType

enum<string>

required

The transaction type.

Available options:

RETAIL,

ATM,

UNIQUE,

CASH_DISBURSEMENT,

BALANCE_INQUIRY,

P2P_DEBIT,

P2P_CREDIT,

CREDIT,

CASHBACK

messageCategory

enum<string>

required

Available options:

REQUEST,

ADJUSTMENT,

SCHEME_ADVICE,

REVERSAL_ADVICE

transactionId

string<biginteger>

accountId

string<biginteger>

originalAmount

object

Amount including currency

Show child attributes

replacementAmount

object

Amount including currency

Show child attributes

merchantCountryCode

string<iso3166-1-countrycode>

A valid ISO-3166-1 alpha-3 country code.

Example:

"FIN"

merchantId

string

acquirerId

string

subMerchantId

string

cardholderVerifications

enum<string>[]

Show child attributes

cardEntryMode

enum<string>

Describes how the card credentials were captured. Possible values:

UNKNOWN - the message from the merchant did not include a distinct method.
MANUAL_ENTRY - the card credentials were manually entered by the merchant.
MAGNETIC_STRIPE_READ - the magnetic stripe of the card was read by a terminal.
CHIP_READ - the EMV chip of the card was read by a terminal
CONTACTLESS - contactless transactions, i.e. the card credentials were read with near field communication (NFC) either from chip or digital wallet.
ELECTRONIC_COMMERCE - the cardholder entered the card credentials as an e-com merchant.

Available options:

UNKNOWN,

MANUAL_ENTRY,

MAGNETIC_STRIPE_READ,

CHIP_READ,

CONTACTLESS,

ELECTRONIC_COMMERCE

cardholderPresent

boolean

cardScheme

enum<string>

Available options:

VISA,

MC

Response

Successful STIP rules evaluation

decision

enum<string>

Spend control decision

Available options:

DECLINE,

APPROVE_PARTIAL,

APPROVE

partialApprovalAmount

object

Amount including currency

Show child attributes

responseCode

string

details

object[]

Show child attributes

⌘I

{
  "decision": "DECLINE",
  "partialApprovalAmount": {
    "amount": 3.14,
    "currency": "EUR"
  },
  "responseCode": "<string>",
  "details": [
    {
      "ruleSetId": "<string>",
      "operator": "ANY",
      "decision": "DECLINE",
      "entityReferences": [
        {
          "id": "<string>",
          "type": "CARD"
        }
      ],
      "partialApprovalAmount": {
        "amount": 3.14,
        "currency": "EUR"
      },
      "ruleEvaluations": [
        {
          "ruleId": "<string>",
          "decision": "DECLINE",
          "partialApprovalAmount": {
            "amount": 3.14,
            "currency": "EUR"
          },
          "settings": {
            "id": "<string>",
            "ruleType": "DECLINE",
            "name": "<string>",
            "filterOperatorType": "ANY",
            "filters": [
              {
                "id": "<string>",
                "type": "MCC",
                "reversed": true
              }
            ]
          }
        }
      ]
    }
  ]
}