Syntch Gateway API

<back to all web services

GetSettlementBatches

Reporting - Settlement
Requires Authentication
Requires any of the roles:Reseller, Merchant
The following routes are available for this service:
GET/reports/settlements/Get a list of settlement batches based on your search criteria.
GetSettlementBatches Parameters:
NameParameterData TypeRequiredDescription
BeginDatequerystringYesBeginning date of the settlement batch record query.
EndDatequerystringNoEnd date of the settlement batch record query.
MerchantKeyquerystringNoThe key of the merchant of the settlement batches.
SortFieldquerystringNoThe field name by which the records will be sorted. Default is 'BatchDate'.

Allowable Values

  • BatchDate
  • BatchId
  • TotalAmount
SortedRequestDto Parameters:
NameParameterData TypeRequiredDescription
SortDirectionquerystringNoThe direction in which the records will be sorted. Default is 'asc'.

Allowable Values

  • Asc
  • Desc
SortFieldquerystringNoThe field name by which the records will be sorted.
PaginatedRequestDto Parameters:
NameParameterData TypeRequiredDescription
PageSizequeryshortNoThe number of records per page. Default is 20.
PageNumberqueryshortNoThe page number to fetch. Default is 1.

To override the Content-type in your clients, use the HTTP Accept Header, append the .xml suffix or ?format=xml

HTTP + XML

The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.

GET /reports/settlements/ HTTP/1.1 
Host: syntch.simpay.net 
Accept: application/xml

HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<ArrayOfSettlementBatchResults xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Gateway.RestApi.Reporting.Responses">
  <SettlementBatchResults>
    <Batches>
      <SettlementBatch>
        <BatchDate>0001-01-01T00:00:00</BatchDate>
        <BatchId>String</BatchId>
        <MID>String</MID>
        <Message>String</Message>
        <Processor>String</Processor>
        <ReturnAmount>0</ReturnAmount>
        <SaleAmount>0</SaleAmount>
        <TotalAmount>0</TotalAmount>
        <TransactionCount>0</TransactionCount>
      </SettlementBatch>
    </Batches>
    <MerchantName>String</MerchantName>
    <Pagination xmlns:d3p1="http://schemas.datacontract.org/2004/07/Gateway.Infrastructure.Common">
      <d3p1:CurrentPageNumber>0</d3p1:CurrentPageNumber>
      <d3p1:PageSize>0</d3p1:PageSize>
      <d3p1:TotalRecordCount>0</d3p1:TotalRecordCount>
    </Pagination>
  </SettlementBatchResults>
</ArrayOfSettlementBatchResults>