Batches

Batches Controller

Get all batches

get

Valid formats for the ‘start-date’ and ‘end-date’ fields include the following: MM-dd-yyyy hh:mm a, MM-dd-yy HH:mm, MM-dd-yy HH:mm z, yyyy-MM-dd HH:mm, yyyy-MM-dd HH:mm z

Query parameters

paramanyRequired

param

levelanyOptional

Level of search. Default is terminal level. Set to 'merchant' to query all batches for this merchant.

start-dateanyOptional

filters the batches list by the created date/time. Setting start date will return batches that were processed after this date/time. Setting both start and end date creates a range

end-dateanyOptional

use with start date to create range

pageanyOptional

The page number. Use the page and page-size for pagination

page-sizeanyOptional

Number of results per page

descendinganyOptional

list results in descending order, default is true

statusanyOptional

Batch status (OPEN,CLOSED,PENDING,FAILED). A PENDING status means the batch is being processed. The FAILED means a batch was attempted and failed. A batch that has FAILED can be resubmitted.

Header parameters

api-keyanyRequired

api-key-value

Body

refund-countstringOptional

Number of refunds in the batch

refund-totalstringOptional

total dollar amount of refunds in the batch

sales-countstringOptional

Number of sales/auths in batch

sales-totalstringOptional

Total dollar amount of sales in the batch

net-amountstringOptional

Total dollar amount in the batch

total-countstringOptional

Total number of transactions in the batch

confirmation-codestringOptional

on a settled batch the confirmation code

settledstringOptional

date and time of settled batch

Responses

200

Success

application/xmlapplication/json

204

No Content

application/xmlapplication/json

400

Something is wrong with your request

401

Unauthorized

403

Forbidden

404

Not Found

500

Internal server error

get

HTTPcURLJavaScriptPython

GET //rest/v2/batches HTTP/1.1
Host: gateway-sb.clearent.net
Content-Type: application/x-www-form-urlencoded
Accept: */*
Content-Length: 172

"refund-count='text'&refund-total='text'&sales-count='text'&sales-total='text'&net-amount='text'&total-count='text'&confirmation-code='text'&settled='text'"

<?xml version="1.0"?>
<object>
	<batch>
		<confirmation-code>00039999</confirmation-code>
		<date-opened>11113333</date-opened>
		<id>00101</id>
		<merchant-id>000000101202</merchant-id>
		<net-amount>8800.00</net-amount>
		<refund-count>2</refund-count>
		<refund-total>200.00</refund-total>
		<sales-count>32</sales-count>
		<sales-total>9000.00</sales-total>
		<settled>2020-05-02T19:48:04.993Z</settled>
		<status>CLOSED</status>
		<switch-batch-id>text</switch-batch-id>
		<terminal-id>11113333</terminal-id>
		<terminal-name>Station 1</terminal-name>
		<total-count>34</total-count>
	</batch>
	<payloadType>text</payloadType>
</object>