MiPaymentChoice API: Reporting - Get Batch

General

Get transaction details by batch identifier.

Routes

Route	Description
GET /reports/settlements/{batchId}	Get a collection of transactions based on the batch identifier.

Request Headers

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

Parameter Details

Property	Required	Data	Additional Information
batchId	Yes	String	The batch identifier to retrieve.

Response Body

{ 
"Transactions":[ 
    { 
    "PnRef":0,
    "InvoiceNumber":"string",
    "SequenceNumber":"string",
    "TransactionTimestamp":"2019-02-23T20:00:40.199Z",
    "AuthorizationTimestamp":"2019-02-23T20:00:40.199Z",
    "MerchantKey":0,
    "UserName":"string",
    "RegisterNumber":"string",
    "ResellerKey":0,
    "PaymentType":"string",
    "TransactionType":"string",
    "Processor":"string",
    "SettlementMessage":"string",
    "VoidFlag":"string",
    "SettleFlag":"string",
    "SettlementTimestamp":"2019-02-23T20:00:40.199Z",
    "IP":"string",
    "CustomerId":"string",
    "OriginalTransactionPnRef":0,
    "CustomerReference":"string",
    "BatchNumber":"string",
    "BatchSequenceNumber":"string",
    "Adjusted":"string",
    "TransactionFinishTimestamp":"2019-02-23T20:00:40.199Z",
    "ProcessorRequestTimestamp":"2019-02-23T20:00:40.199Z",
    "ProcessorResponseTimestamp":"2019-02-23T20:00:40.199Z",
    "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"
        }
    ]
    }
],
"Pagination":{ 
    "CurrentPageNumber":0,
    "PageSize":0,
    "TotalRecordCount":0
    }
}