Batch Report

The Batch Report displays the settled batches for a given date range. The batches are grouped by batch number

Get batch history

GET https://<Platform-host>/api/merchant/:merchant_id/settlement

Path Parameters

Name	Type	Description
merchant_id*	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

200 List of batches

Batch Report Field Definitions

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

Sample Response

{
    "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
    }
}