v1

latestOpenAPI 3.1.02026-07-242325051.4 MB
Transactions

Transactions:Instore

Retrieve all instore transactions for a merchant

get/transactions/instore

Query parameters

limitinteger

Limit the returned records. If not supplied we will default to 100 records

pageinteger

Indicate which page you want in your result set. If not supplied we will default to page 1

eqstring date

Get results that equal the given value

neqstring date

Get results that do not equal the given value

gtstring date

Get results that are greater than the given value

gtestring date

Get results that are greater than or equal to the given value

ltstring date

Get results that are less than the given value

ltestring date

Get results that are less than or equal to the given value

The date at which the transaction was created

{
  "eq": "1999-02-15",
  "neq": "1999-02-15",
  "gt": "1999-02-15",
  "gte": "1999-02-15",
  "lt": "1999-02-15",
  "lte": "1999-02-15"
}
eqinteger

Get results that equal the given value

neqinteger

Get results that do not equal the given value

gtinteger

Get results that are greater than the given value

gteinteger

Get results that are greater than or equal to the given value

ltinteger

Get results that are less than the given value

lteinteger

Get results that are less than or equal to the given value

The amount in cents.

{
  "eq": 10,
  "neq": 10,
  "gt": 10,
  "gte": 10,
  "lt": 10,
  "lte": 10
}
eqstring

Get results that equal the given value

neqstring

Get results that do not equal the given value

instring

Get results that correspond to one of the provided values.

ninstring

Get results that do not correspond to one of the provided values.

The terminal transaction ID.

{
  "eq": "TT-####-####-####.",
  "neq": "TT-####-####-####.",
  "in": "TT-####-####-####.",
  "nin": "TT-####-####-####."
}
eqstring

Get results that equal the given value

neqstring

Get results that do not equal the given value

likestring

Get results that are similar to the given value

nlikestring

Get results that are not similar to the given value

The orderId of the transaction.

{
  "eq": "0000000000X00000",
  "neq": "0000000000X00000",
  "like": "0000000000X00000",
  "nlike": "0000000000X00000"
}
eqstring

Get results that equal the given value

neqstring

Get results that do not equal the given value

likestring

Get results that are similar to the given value

nlikestring

Get results that are not similar to the given value

Is shown on the statement of the payer.

{
  "eq": "Example description.",
  "neq": "Example description.",
  "like": "Example description.",
  "nlike": "Example description."
}
eqstring

Get results that equal the given value

neqstring

Get results that do not equal the given value

instring

Get results that correspond to one of the provided values.

ninstring

Get results that do not correspond to one of the provided values.

The service code for which the transaction was started.

{
  "eq": "SL-1234-4321",
  "neq": "SL-1234-4321",
  "in": "SL-1234-4321",
  "nin": "SL-1234-4321"
}
eqinteger

Get results that equal the given value

neqinteger

Get results that do not equal the given value

ininteger

Get results that correspond to one of the provided values.

nininteger

Get results that do not correspond to one of the provided values.

The status code of the transaction.

{
  "eq": 100,
  "neq": 100,
  "in": 100,
  "nin": 100
}
eqstring

Get results that equal the given value

neqstring

Get results that do not equal the given value

likestring

Get results that are similar to the given value

nlikestring

Get results that are not similar to the given value

The first free value which can be tracked in the stats.

{
  "eq": "extra1",
  "neq": "extra1",
  "like": "extra1",
  "nlike": "extra1"
}
eqstring

Get results that equal the given value

neqstring

Get results that do not equal the given value

likestring

Get results that are similar to the given value

nlikestring

Get results that are not similar to the given value

The second free value which can be tracked in the stats.

{
  "eq": "extra2",
  "neq": "extra2",
  "like": "extra2",
  "nlike": "extra2"
}
eqstring

Get results that equal the given value

neqstring

Get results that do not equal the given value

likestring

Get results that are similar to the given value

nlikestring

Get results that are not similar to the given value

The third free value which can be tracked in the stats.

{
  "eq": "extra3",
  "neq": "extra3",
  "like": "extra3",
  "nlike": "extra3"
}
eqstring

Get results that equal the given value

neqstring

Get results that do not equal the given value

likestring

Get results that are similar to the given value

nlikestring

Get results that are not similar to the given value

The object which can be tracked in stats.

{
  "eq": "object",
  "neq": "object",
  "like": "object",
  "nlike": "object"
}

Response

Ok.

totalinteger
countinteger
pagesinteger