MiPaymentChoice API: Reporting - Get Transactions

From MiPaymentChoice Gateway
Jump to navigation Jump to search

General

Returns detailed data for one or more previously executed transactions.

Routes

Route Description
GET /reports/transactions/{pnRefs} Gets the details of one to ten transactions. For more transaction, please use QueryTransactions.

Request Headers

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

Parameter Details

Property Required Data Additional Information
pnRefs Yes String A comma-separated list of PnRef numbers (i.e. 23423,53453). There is a limit of 10 PnRefs for this request. Please use /reports/transactions to query for more transactions.

Response Data

{
  "PnRef": 0,
  "InvoiceNumber": "string",
  "SequenceNumber": "string",
  "TransactionTimestamp": "2019-02-15T19:59:12.050Z",
  "AuthorizationTimestamp": "2019-02-15T19:59:12.050Z",
  "MerchantKey": 0,
  "UserName": "string",
  "RegisterNumber": "string",
  "ResellerKey": 0,
  "PaymentType": "string",
  "TransactionType": "string",
  "Processor": "string",
  "SettlementMessage": "string",
  "VoidFlag": "string",
  "SettleFlag": "string",
  "SettlementTimestamp": "2019-02-15T19:59:12.050Z",
  "IP": "string",
  "CustomerId": "string",
  "OriginalTransactionPnRef": 0,
  "CustomerReference": "string",
  "BatchNumber": "string",
  "BatchSequenceNumber": "string",
  "Adjusted": "string",
  "TransactionFinishTimestamp": "2019-02-15T19:59:12.050Z",
  "ProcessorRequestTimestamp": "2019-02-15T19:59:12.050Z",
  "ProcessorResponseTimestamp": "2019-02-15T19:59:12.050Z",
  "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"
    }
  ]
}