Close Batch
Overview
This page will show you how to close your current batch. The API endpoint below takes the currently open batch and closes it.
The API endpoint is as follows:
POST /api/v2/batches/current/close
Quick Start
Request
curl -X POST https://sandbox.usaepay.com/api/v2/batches/current/close
-H "Content-Type: application/json"
-H "Authorization: Basic X1Y4N1F0YjUxM0NkM3ZhYk03UkMwVGJ0SldlU284cDc6czIvYWJjZGVmZ2hpamtsbW5vcC9iNzRjMmZhOTFmYjBhMDk3NTVlMzc3ZWU4ZTIwYWE4NmQyYjkyYzNkMmYyNzcyODBkYjU5NWY2MzZiYjE5MGU2"
This cURL request is an example of a merchant closing their current batch.
Response
{
"type":"batch",
"key":"7t1sf8ysd1kzd1b",
"batchnum":"2",
"opened":"2017-10-23 14:06:53",
"status":"closing"
}
This is the sample response object sent back from the server.
Response Variables
| Variable | Type | Description |
|---|---|---|
| type | string | This is a batch. |
| key | string | This is the key of the batch. |
| batchnum | string | The batch sequence number. The first batch the merchant closes is 1, the second is 2, etc. |
| opened | date | The date when the batch opened |
| status | string | The status of the batch. The batch is closing. |
Change Log
| Date | Change |
|---|---|
| 2017-08-01 | Added page. |
| 2017-11-29 | Added code examples to page. |