Sign in

v1

latestOpenAPI 3.0.32026-07-26208618579.9 KB
Spend Control Test Endpoint

Test Spend Control Rules Evaluation

This operation can be used to evaluate spend control rules for a test transaction.

post/v1/evaluate/test

Query parameters

auditUserstring required

The audit user to log the request

Request body

cardIdstring biginteger required
merchantCategoryCodestring required
merchantCountryCodestring iso3166-1-countrycode

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

merchantIdstring
acquirerIdstring
subMerchantIdstring
cardholderVerificationsCardholderVerificationType[]
cardEntryMode'MANUAL_ENTRY' | 'MAGNETIC_STRIPE_READ' | 'CHIP_READ' | 'CONTACTLESS' | 'ELECTRONIC_COMMERCE'

Describes how the card credentials were captured. Possible values:

  • 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.
cardholderPresentboolean
transactionType'RETAIL' | 'CASH' | 'ATM' | 'CREDIT' | 'UNIQUE' | 'P2P_CREDIT' | 'P2P_DEBIT' | 'BALANCE_INQUIRY' | 'CASH_DISBURSEMENT' required

The transaction type. The only fully supported type is RETAIL. Other transaction types may be used, but no guarantees are made about their behaviour. Some transaction types have specific limitations:

  • ATM - In order to create ATM transactions, merchantData.merchantCategoryCode must be 6011. This behaviour is downstream from the VISA and MC authorization systems. If a different code is used, transactions will be treated as CASH
cardScheme'VISA' | 'MC'
messageCategory'REQUEST' | 'ADJUSTMENT' | 'SCHEME_ADVICE' | 'REVERSAL_ADVICE'
transactionTimestampstring date-time
transactionIdstring biginteger
terminalCategoryCodestring

Example request

{
  "settlementAmount": {
    "amount": 3.14,
    "currency": "EUR"
  },
  "merchantCountryCode": "FIN",
  "transactionTimestamp": "2025-11-14T13:46:16.61Z"
}

Response

Successful rules evaluation

decision'DECLINE' | 'APPROVE_PARTIAL' | 'APPROVE'

Spend control decision

responseCodestring

Example response

{
  "partialApprovalAmount": {
    "amount": 3.14,
    "currency": "EUR"
  },
  "details": [
    {
      "partialApprovalAmount": {
        "amount": 3.14,
        "currency": "EUR"
      },
      "ruleEvaluations": [
        {
          "partialApprovalAmount": {
            "amount": 3.14,
            "currency": "EUR"
          }
        }
      ]
    }
  ]
}