MiPaymentChoice API: Reporting - Query Transactions

General

Provides a paginated result set of transaction details that meet various query parameter values.

Routes

Route	Description
GET /reports/transactions/	Get a collection of transactions based on the search criteria.
POST /reports/transactions/	Get a collection of transactions based on the search criteria.

POST is provided to allow simple use of multiple request parameters.

Request Headers

Header	Value
Authentication	Bearer [authentication (JWT) token]
Content-Type	application/json

Request Body

Used with POST requests. These parameters can be used in the route for GET requests.

{
  "BeginDate": "2019-02-15T19:59:12.101Z",
  "EndDate": "2019-02-15T19:59:12.101Z",
  "TransactionTypes": [
    "string"
  ],
  "InvoiceNumber": "string",
  "SettlementFlag": "All",
  "SettleBeginDate": "2019-02-15T19:59:12.101Z",
  "SettleEndDate": "2019-02-15T19:59:12.101Z",
  "SettleMessage": "string",
  "SettleStatus": "string",
  "Username": "string",
  "ResultCodes": [
    "string"
  ],
  "Register": "string",
  "ApprovalCode": "string",
  "NameOnInstrument": "string",
  "CustomerId": "string",
  "ContractId": "string",
  "ContractKey": 0,
  "SortField": "PnRef",
  "TotalAmountMax": 0,
  "TotalAmountMin": 0,
  "PaymentTypes": [
    "string"
  ],
  "CardNumber": "string",
  "CheckTypes": [
    "string"
  ],
  "CheckAccountTypes": [
    "string"
  ],
  "CheckAccountNumber": 0,
  "CheckRoutingNumber": 0,
  "SortDirection": "Asc",
  "PageSize": 0,
  "PageNumber": 0
}

Parameter Details

Property	Required	Data	Additional Information
BeginDate	Yes	DateTime	The beginning date for the transaction query.
EndDate		DateTime	Defaults to the current date if not supplied.
PaymentTypes		Array	'VISA', 'DINERS', 'AMEX', 'MASTERCARD', 'JAL', 'JCB', 'DISCOVER', 'CARTEBLANCHE', 'EBT', 'LOYALTY', 'DEBIT', 'ECG', 'CASH', 'VERIFY', 'ECHECK'.
CheckTypes		Array	'Business', 'Personal'.
CheckAccountTypes		Array	'Checking', 'Savings'.
TransactionTypes		Array	'Authorization', 'Sale', 'Return', 'Void', 'Force', 'Capture', 'CaptureAll', 'RepeatSale', 'Adjustment', 'Activate', 'Deactivate', 'Redeem', 'Inquire', 'Reload'.
ResultCodes		Array	See Transaction Processing for a list of Result Codes.
SortField		String	Defaults to 'PnRef'. 'PnRef', 'InvoiceNumber', 'TransactionTimestamp', 'AuthorizationTimestamp', 'MerchantKey', 'ResellerKey', 'PaymentType', 'TransactionType', 'Processor'
SortDirection		String	Defaults to 'ASC'. 'DESC'.
PageSize		Numeric	Defaults to 20.
PageNumber		Numeric	Defaults to 1.

Response Body

[
  {
    "PnRef": 0,
    "InvoiceNumber": "string",
    "SequenceNumber": "string",
    "TransactionTimestamp": "2019-02-15T22:02:24.482Z",
    "AuthorizationTimestamp": "2019-02-15T22:02:24.482Z",
    "MerchantKey": 0,
    "UserName": "string",
    "RegisterNumber": "string",
    "ResellerKey": 0,
    "PaymentType": "string",
    "TransactionType": "string",
    "Processor": "string",
    "SettlementMessage": "string",
    "VoidFlag": "string",
    "SettleFlag": "string",
    "SettlementTimestamp": "2019-02-15T22:02:24.482Z",
    "IP": "string",
    "CustomerId": "string",
    "OriginalTransactionPnRef": 0,
    "CustomerReference": "string",
    "BatchNumber": "string",
    "BatchSequenceNumber": "string",
    "Adjusted": "string",
    "TransactionFinishTimestamp": "2019-02-15T22:02:24.482Z",
    "ProcessorRequestTimestamp": "2019-02-15T22:02:24.482Z",
    "ProcessorResponseTimestamp": "2019-02-15T22:02:24.482Z",
    "BatchId": "string",
    "ReversalFlag": "string",
    "CardDetail": {
      "Token": "string",
      "MaskedPAN": "string",
      "NameOnCard": "string",
      "AuthorizationAmount": 0,
      "TipAmount": 0,
      "TotalAmount": 0,
      "CashBackAmount": 0,
      "SurchargeAmount": 0,
      "AccountType": "string",
      "ResultCode": "string",
      "ResultText": "string",
      "ApprovalCode": "string",
      "HostReferenceNumber": "string",
      "AvsResponse": "string",
      "AvsResponseText": "string",
      "CvvResponse": "string",
      "CvvResponseText": "string",
      "Level3Amount": 0,
      "CardExpiration": "string"
    },
    "CheckDetail": {
      "Token": "string",
      "CheckNumber": "string",
      "AccountNumber": "string",
      "RoutingNumber": "string",
      "DriversLicenseNumber": "string",
      "SocialSecurityNumber": "string",
      "DateOfBirth": "string",
      "StateCode": "string",
      "NameOnCheck": "string",
      "EmailAddress": "string",
      "PhoneNumber": "string",
      "CheckAmount": 0,
      "ResultCode": "string",
      "ResultText": "string",
      "HostApproval": "string",
      "HostReferenceNumber": "string",
      "ResultMessage": "string",
      "SecondaryResultMessage": "string",
      "TertiaryResultMessage": "string",
      "AccountType": "string",
      "CheckType": "string"
    },
    "CashDetail": {
      "CashAmount": 0
    },
    "CustomFields": [
      {
        "Name": "string",
        "Value": "string"
      }
    ]
  }
]