Skip to content

Rule

Operations

Rule Verification

Request

Used to check for various processing rules such as surcharge eligibility.

Integration Methods:

  • Host Direct

See the Integration Methods and URLs Section sections of the Development Quick Start guide for details regarding each processing option.

See the JSON Body Schemas for more details on the various JSON body formats.

Security
AccessToken
Headers
InterfaceVersionstring, <= 11 charactersrequired

Refers to the version of the program or application that is sending requests to Shift4. The following special characters are not allowed: $ % : ^ - ~ < > , ? “ ” ‘ ’ { } [ ] \ + =

Example:2.1
InterfaceNamestring, <= 25 charactersrequired

Refers to the name of the program or application that is sending requests to Shift4. This should be the name of the program that you purchased or created. The following special characters are not allowed: $ % : ^ - ~ ` < > , ? “ ” ‘ ’ { } [ ] \ + =

Example:ForwardPOS
CompanyNamestring, <= 26 charactersrequired

Refers to the vendor or partner that designed and certified the interface. The information you use in this field should match what Shift4 has on file or what was agreed upon in your Integration Plan. The following special characters are not allowed: $ % : ^ - ~ ` < > , ? “ ” ‘ ’ { } [ ] \ + =

Example:PAWS
AccessTokenstring, (uuid), <= 52 charactersrequired

A security credential used to authenticate API requests and all i4Go® authorizeClient/preauthorizeClient requests. An Access Token is the alias for the merchant account and interface being used. The Access Token is required in all requests except an Access Token Exchange request, which generates an Access Token using an authToken and clientGuid.

Example:EA79FB05-3AA7-4500-AF9A-73F986FF2C1D
Bodyapplication/jsonrequired
One of:
dateTimestring, (ISO 8601)required

The date and time in ISO 8601 format including the timezone offset (yyyy-mm-ddThh:mm:ss.nnn+hh:mm).

Must be sent as the local date/time of the merchant. For example, a request processed at a merchant in the Pacific time zone at 9:18am on April 15th 2021 would be sent as 2021-04-15T09:18:23.283-07:00

Example:"2024-05-21T09:18:23.283-07:00"
amountobjectrequired

Object containing information regarding the amount being requested. The total field within the object is required and specifies the amount being requested.

Note: For merchants that are configured to allow multiple currencies, the amount fields can specify up to three decimal places. However, the number of decimal places can not exceed the number allowed for the specified currency. See the Currency Codes section for details.

ruleCheckArray of stringswrite-onlyrequired

Specifies which rule checks are being requested:

ValueDescription
SURCHARGEChecks to see if a card is eligible for surcharging. If eligible the surcharge object will be returned containing the surcharge percentage that can be applied.
Items Value:"SURCHARGE"
Example:
[
  "SURCHARGE"
]
transactionobjectrequired
cardobjectrequired
clerkobject
{
  "dateTime": "2024-05-21T09:18:23.283-07:00",
  "amount": {
    "total": 160
  },
  "ruleCheck": [
    "SURCHARGE"
  ],
  "transaction": {
    "invoice": "0510093358",
    "vendorReference": "12382-01"
  },
  "card": {
    "expirationDate": 1230,
    "token": {
      "value": "8048471746471119"
    }
  },
  "clerk": {
    "numericId": 1576
  }
}

Responses

Request was processed

Bodyapplication/json
resultArray of objects
Response
{
  "result": [
    {
      "dateTime": "2024-05-21T09:18:23.283-07:00",
      "amount": {
        "total": 163.2,
        "surcharge": 3.2
      },
      "card": {
        "number": "XXXXXXXXXXXX1119",
        "token": { … },
        "type": "VS"
      },
      "surcharge": {
        "result": "P",
        "transactionId": "string",
        "percentage": 2
      },
      "transaction": {
        "invoice": "0510093358",
        "vendorReference": "12382-01"
      },
      "merchant": {
        "mid": 15877,
        "name": "Merchant XYZ"
      },
      "server": {
        "name": "TM01CE"
      }
    }
  ]
}