MiPaymentChoice API: Reporting - Query Settlements

General

Get a list of settlement batches based on search criteria.

Routes

Route	Description
GET /reports/settlements	Get a list of settlement batches based on search criteria.

Request Headers

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

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.
SortField		String	Defaults to 'BatchDate'. 'BatchId', 'TotalAmount'.
SortDirection		String	Defaults to 'ASC'.  'DESC'.
PageSize		Numeric	Defaults to 20.
PageNumber		Numeric	Defaults to 1.

Response Body

[  
   {  
      "MerchantName":"string",
      "Batches":[  
         {  
            "BatchId":"string",
            "BatchDate":"2019-02-23T20:00:40.256Z",
            "Processor":"string",
            "Message":"string",
            "TransactionCount":0,
            "SaleAmount":0,
            "ReturnAmount":0,
            "TotalAmount":0,
            "MID":"string"
         }
      ],
      "Pagination":{  
         "CurrentPageNumber":0,
         "PageSize":0,
         "TotalRecordCount":0
      }
   }
]