> For the complete documentation index, see [llms.txt](https://docs.payengine.co/payengine-api-v2.5/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.payengine.co/payengine-api-v2.5/transactions/batch-report.md).

# Batch Report

## Get batch history

<mark style="color:blue;">`GET`</mark> `https://<Platform-host>/api/merchant/:merchant_id/settlement`

#### Path Parameters

| Name                                           | Type   | Description |
| ---------------------------------------------- | ------ | ----------- |
| merchant\_id<mark style="color:red;">\*</mark> | string | Merchant ID |

#### Query Parameters

| Name          | Type   | Description                   |
| ------------- | ------ | ----------------------------- |
| page          | string | Page number to get            |
| amount\[from] | string | Settlements amount range from |
| amount\[to]   | string | Settlements amount range to   |
| date\[from]   | string | Unix epoch. Date range from   |
| date\[to]     | string | Unix epoch. Date range to     |

{% tabs %}
{% tab title="200 List of batches" %}
{% tabs %}
{% tab title="Batch Report Field Definitions" %}

<table><thead><tr><th width="168">Field Name</th><th>Type</th><th width="159">Description</th><th>Required?</th></tr></thead><tbody><tr><td>data</td><td>array</td><td>Settled batches</td><td>Required</td></tr><tr><td>data[i].id</td><td>string</td><td>Platform unique batch ID</td><td>Required</td></tr><tr><td>data[i].created_at</td><td>string</td><td>Timestamp when batch was created</td><td>Required</td></tr><tr><td>data[i].updated_at</td><td>string</td><td>Timestamp when batch was updated</td><td>Required</td></tr><tr><td>data[i].batch_number</td><td>integer</td><td>Batch Number</td><td>Required</td></tr><tr><td>data[i].amount</td><td>string</td><td>Settlement amount for this batch</td><td>Required</td></tr><tr><td>data[i].data</td><td>object</td><td>Batch data</td><td>Required</td></tr><tr><td>data[i].data.approved_amount</td><td>string</td><td>Total approved amount in this batch</td><td>Required</td></tr><tr><td>data[i].total_no_sales</td><td>integer</td><td>Total number of sales transactions</td><td>Required</td></tr><tr><td>data[i].total_no_refunds</td><td>integer</td><td>Total number of refund transactions</td><td>Required</td></tr><tr><td>data[i].batch_reference</td><td>string</td><td>Batch Reference</td><td>Optional</td></tr><tr><td>data[i].merchant_payout_id</td><td>string</td><td>Payout Id that this batch belongs to</td><td>Optional</td></tr><tr><td>data[i].data.void_amount</td><td>string</td><td>Total void amount in this batch</td><td>Required</td></tr><tr><td>data[i].data.card_report</td><td>object</td><td>Batch report by card</td><td>Required</td></tr><tr><td>data[i].data.ach_report</td><td>object</td><td>ACH report for this batch</td><td>Required</td></tr><tr><td>data[i].data.card_report.&#x3C;cardType></td><td>object</td><td>Object example visa, mastercard etc</td><td>Optional</td></tr><tr><td>data[i].data.card_report.&#x3C;cardType>.total_charges</td><td>string</td><td>Total dollar amount for this card type</td><td>Required</td></tr><tr><td>data[i].data.card_report.&#x3C;cardType>.number_of_charges</td><td>integer</td><td>Number of transactions for this card type</td><td>Required</td></tr><tr><td>data[i].data.card_report.&#x3C;cardType>.total_refunds</td><td>string</td><td>Total dollar amount refunded for this card type</td><td>Required</td></tr><tr><td>data[i].data.card_report.&#x3C;cardType>.number_of_refunds</td><td>integer</td><td>Number of refund transactions for this card</td><td>Required</td></tr><tr><td>data[i].data.ach_report.total_charges</td><td>string</td><td>Total ACH dollar amount</td><td>Required</td></tr><tr><td>data[i].data.ach_report.number_of_charges</td><td>integer</td><td>Number of ACH transactions</td><td>Required</td></tr><tr><td>data[i].data.ach_report.total_refunds</td><td>string</td><td>Total ACH dollar amount refunded</td><td>Required</td></tr><tr><td>data[i].data.ach_report.number_of_refunds</td><td>integer</td><td>Number of ACH refund transactions</td><td>Required</td></tr><tr><td>meta</td><td>object</td><td>Metadata for this response</td><td>Required</td></tr><tr><td>meta.total</td><td>integer</td><td>Total batches in this response</td><td>Required</td></tr><tr><td>meta.current_page</td><td>integer</td><td>Current page</td><td>Required</td></tr><tr><td>meta.total_pages</td><td>integer</td><td>Total number of pages for this search</td><td>Required</td></tr></tbody></table>
{% endtab %}
{% endtabs %}
{% endtab %}
{% endtabs %}

{% tabs %}
{% tab title="Sample Response" %}

```javascript
{
    "data": [
        {
            "id": "758ad65f-9849-43a9-999a-dc5a94887110",
            "merchant_id": "b0ad3bfe-c7a1-4def-9840-6c8f2570d2ce",
            "created_at": "2022-02-17T02:00:06.922Z",
            "updated_at": "2022-02-17T02:00:06.922Z",
            "batch_number": 15,
            "amount": "0.02",
            "total_no_sales": 10,
            "total_no_refunds": 1,
            "batch_reference": "415453214",
            "merchant_payout_id": "64333bd6-6a05-4bba-8d3e-a559ba118e04",
            "data": {
                "approved_amount": "0.02",
                "void_amount": "0.00",
                "card_report": {
                    "visa": {
                        "total_charges": "0.02",
                        "number_of_charges": 1,
                        "total_refunds": "0.00",
                        "number_of_refunds": 0
                    }
                },
                "ach_report": {
                    "total_charges": "0.00",
                    "number_of_charges": 0,
                    "total_refunds": "0.00",
                    "number_of_refunds": 0
                }
            }            
        },
        {
            "id": "65883bd6-6b08-4bba-8d3e-a449ba009e04",
            "merchant_id": "b0ad3bfe-c7a1-4def-9840-6c8f2570d2ce",
            "created_at": "2022-02-05T02:00:07.313Z",
            "updated_at": "2022-02-05T02:00:07.313Z",
            "batch_number": 14,
            "amount": "2.20",
            "batch_reference": "593502035:5929583",
            "merchant_payout_id": "64333bd6-6a05-4bba-8d3e-a559ba118e04",
            "data": {
                "approved_amount": "2.20",
                "void_amount": "0.00",
                "card_report": {
                    "visa": {
                        "total_charges": "2.20",
                        "number_of_charges": 1,
                        "total_refunds": "0.00",
                        "number_of_refunds": 0
                    }
                },
                "ach_report": {
                    "total_charges": "0.00",
                    "number_of_charges": 0,
                    "total_refunds": "0.00",
                    "number_of_refunds": 0
                }
            }
        }
    ],
    "meta": {
        "total": 2,
        "current_page": 1,
        "total_pages": 1
    }
}
```

{% endtab %}
{% endtabs %}