Batches

This section describes the resource used to manage batches.

List

Method: GET

Url: https://gateway.olstest.com/rest/v1/batches

Filter fields

Name Format Description Default
page_size N Limits the number of batches returned by this method. Sometimes called "limit." Maximum is 100. 25
page N Specifies which page of results is returned. Page index starts at '1'. Ex: if page = 2 and pageSize = 50, then this method will return batches 51 - 100 (or the maximum batches available). If no batches exist in this range, then a blank list is returned. 1
order_by A Specifies which field to sort the batch list by. Field names are case sensitive. See "Other Fields" list below for valid fields. id
descending A Specifies which direction to sort the batch list by. Valid values are true and false. true
start_date A/N Filters the batches list by the settled date / time. Setting start_date will return batches that were settled after this date / time. Setting both start_date and end_date creates a range. See the "Valid Date / Time Formats" list below.
end_date A/N Filters the batches list by the settled date / time. Setting end_date will return batches that were settled before this date / time. Setting both start_date and end_date creates a range. See the "Valid Date / Time Formats" list below.
Valid Date / Time Formats

  • MM-dd-yy hh:mm a
  • MM-dd-yy HH:mm z
  • MM-dd-yy HH:mm

Other Fields

Other fields available for filtering are: id, amount, type, result, last_four, authorization_code, invoice, order_id, first_name, last_name. See the Full Fields List for field details.

 
GET /rest/v1/batches?page_size=2 HTTP/1.1 
Host: gateway.olstest.com 
Accept: application/xml 
api_key: a20effd6dc1d4512888e6b06d870248a 
 
HTTP/1.1 200 OK 
Content-Type: application/xml 
 
<batches> 
  <batch> 
    <id>2</id> 
    <refund_count>0</refund_count> 
    <refund_total>0.00</refund_total> 
    <sales_count>4</sales_count> 
    <sales_total>1743.63</sales_total> 
    <net_amount>1743.63</net_amount> 
    <status>OPEN</status> 
    <total_count>4</total_count> 
  </batch> 
  <batch> 
    <id>1</id> 
    <confirmation_code>000000</confirmation_code> 
    <refund_count>1</refund_count> 
    <refund_total>844.97</refund_total> 
    <sales_count>3</sales_count> 
    <sales_total>1936.19</sales_total> 
    <net_amount>1091.22</net_amount> 
    <settled>2012-09-17T10:44:16.860-05:00</status> 
    <status>CLOSED</status> 
    <total_count>4</total_count> 
  </batch> 
</batches> 
 
HTTP/1.1 204 No Content 

Get Open Batch

Method: GET

Url: https://gateway.olstest.com/rest/v1/batches/open

 
GET /rest/v1/batches/open HTTP/1.1 
Host: gateway.olstest.com 
Accept: application/xml 
api_key: a20effd6dc1d4512888e6b06d870248a 
 
HTTP/1.1 200 OK 
Content-Type: application/xml 
 
<batch> 
  <id>2</id> 
  <refund_count>0</refund_count> 
  <refund_total>0.00</refund_total> 
  <sales_count>4</sales_count> 
  <sales_total>1743.63</sales_total> 
  <net_amount>1743.63</net_amount> 
  <status>OPEN</status> 
  <total_count>4</total_count> 
</batch> 
 
HTTP/1.1 204 No Content 

Close Open Batch

Method: PUT

Url: https://gateway.olstest.com/rest/v1/batches/open

 
PUT /rest/v1/batches/open HTTP/1.1 
Host: gateway.olstest.com 
Accept: application/xml 
api_key: a20effd6dc1d4512888e6b06d870248a 
 
HTTP/1.1 200 OK 
Content-Type: application/xml 
 
<batch> 
  <id>1</id> 
  <confirmation_code>000000</confirmation_code> 
  <refund_count>1</refund_count> 
  <refund_total>844.97</refund_total> 
  <sales_count>3</sales_count> 
  <sales_total>1936.19</sales_total> 
  <net_amount>1091.22</net_amount> 
  <settled>2012-09-17T10:44:16.860-05:00</status> 
  <status>CLOSED</status> 
  <total_count>4</total_count> 
</batch> 
 
HTTP/1.1 204 No Content 

Response Fields

Name Format Description
id A/N OLS InComm Gateway unique batch ID.
status A The batch's current status. Value may be:
  • OPEN
  • CLOSED
There can be only one open batch at a time.
refund_count N Total number of refund (Matched and Unmatched) transactions included in this batch. Voided transactions are not counted.
refund_amount N The total, in USD, of all refund transactions included in this batch. Voided transactions are not counted.
sales_count N Total number of sale (SALE, FORCED SALE, CAPTURE) transactions included in this batch. Voided transactions are not counted.
sales_amount N The total, in USD, of all sale (SALE, FORCED SALE, CAPTURE) transactions included in this batch. Voided transactions are not counted.
total_count N Total number of all transactions included in this batch. Voided transactions are not counted.
total_amount N The total, in USD, of all transactions included in this batch. Voided transactions are not counted.
settled Date Represents the date / time that this batch was closed for settlement.
confirmation_code N The batch close confirmation code.