StatusList

StatusList retrieves a paginated list of transactions processed on the terminal, filtered by payment type and index range. All the responses have GeneralResponse section that informs about successful result or error. See Error Codes and Messages.

Request Body

application/json

PaymentType*string

Indicates electronic data capture (EDC) type.

MerchantNumber?|

Merchant number for multi-merchant environment. If not present in multi-merchant environment, transaction will be cancelled.

Formatint32

Range1 <= value <= 5

TransactionFromIndex*integer

Starting index (1-based) of the transaction range to retrieve.

Formatint32

Range1 <= value <= 5000

TransactionToIndex*integer

Ending index (1-based) of the transaction range to retrieve.

Formatint32

Range1 <= value <= 5000

Tpn?string

Terminal profile number. Can be used to identify the terminal in SPIn Proxy environment.

Length10 <= length <= 12

RegisterId?string

Terminal identifier for register. [Obsolete] Can be used to identify the terminal instead of Tpn in SPIn Proxy environment. Required if no Tpn.

Length2 <= length <= 50

Authkey?string

Merchant's authorization password. Required if no SPInToken.

Length10 <= length <= 10

SPInProxyTimeout?|

Timeout for processing the request with SPIn proxy. If null, the default timeout will be used.

Formatint32

Range1 <= value <= 720

CustomFields?

A collection of custom fields in key-value format.

Response Body

`application/json`

curl -X POST "https://example.com/v2/Payment/StatusList" \  -H "Content-Type: application/json" \  -d '{    "PaymentType": "Credit",    "MerchantNumber": null,    "TransactionFromIndex": 1,    "TransactionToIndex": 10,    "Tpn": "",    "RegisterId": "",    "Authkey": "",    "SPInProxyTimeout": null,    "CustomFields": {}  }'

{
  "Transactions": [
    {
      "GeneralResponse": {
        "HostResponseCode": "",
        "HostResponseMessage": "",
        "ResultCode": "0",
        "StatusCode": "0000",
        "Message": "",
        "DetailedMessage": "",
        "DelayBeforeNextRequest": null
      },
      "PaymentType": "Credit",
      "TransactionType": "",
      "Amounts": {
        "TotalAmount": null,
        "Amount": null,
        "TipAmount": null,
        "FeeAmount": null,
        "TaxAmount": null
      },
      "AuthCode": "",
      "ReferenceId": "",
      "InvoiceNumber": "",
      "SerialNumber": "",
      "BatchNumber": "",
      "TransactionNumber": "",
      "Voided": false,
      "Signature": "",
      "IPosToken": "",
      "Token": "",
      "RRN": "",
      "PNReferenceId": "",
      "MerchantNumber": null,
      "MerchantName": "",
      "ExtendedDataByApplication": {},
      "CardData": {
        "CardType": "",
        "EntryType": "",
        "Last4": "",
        "First4": "",
        "BIN": "",
        "ExpirationDate": "",
        "Name": "",
        "CardBrand": ""
      },
      "EMVData": {
        "ApplicationName": "",
        "AID": "",
        "TVR": "",
        "TSI": "",
        "IAD": "",
        "ARC": ""
      },
      "Receipts": {
        "Customer": "",
        "Merchant": ""
      },
      "L2L3ValidationError": {
        "Description": "",
        "PoNumber": "",
        "PurchaseIdentifier": "",
        "SummaryCommodityCode": "",
        "LineItemCount": "",
        "TaxAmount": "",
        "Quantity": "",
        "UnitOfMeasure": "",
        "UnitCost": "",
        "TaxRate": "",
        "DiscountAmount": "",
        "DebitCreditIndicator": "",
        "ExtLineAmount": "",
        "QuantityExpIndicator": "",
        "UnitPriceDecimal": ""
      },
      "AutoRentalValidationError": {
        "AdjustmentAmount": "",
        "AdjustmentAuditIndicatorCode": "",
        "AgreementReferenceNumber": "",
        "PickupAddress": "",
        "PickupCity": "",
        "PickupCountry": "",
        "PickupCountryCode": "",
        "PickupDate": "",
        "PickupLocation": "",
        "PickupRegionCode": "",
        "PickupState": "",
        "RentalDistance": "",
        "RentalDistanceUnitofMeasure": "",
        "RentalDuration": "",
        "RentalPeriod": "",
        "RentalRate": "",
        "RentalTime": "",
        "ReturnAddress": "",
        "ReturnDate": "",
        "ReturnLocationId": "",
        "ReturnRegionCode": "",
        "ReturnStateCountry": "",
        "ReturnTime": "",
        "ServiceMobile": "",
        "VehicleMake": "",
        "VehicleModel": ""
      }
    }
  ],
  "GeneralResponse": {
    "ResultCode": "0",
    "StatusCode": "0000",
    "Message": "",
    "DetailedMessage": "",
    "DelayBeforeNextRequest": null
  }
}

{
  "GeneralResponse": {
    "ResultCode": "0",
    "StatusCode": "0000",
    "Message": "",
    "DetailedMessage": "",
    "DelayBeforeNextRequest": null
  }
}

Request Body

Response Body

200application/json

400application/json

`application/json`

`application/json`