---
title: "Retrieve batch"
method: GET
path: "/batches/{batchId}"
tags: ["Settlement"]
---

# Retrieve batch

`GET /batches/{batchId}`

Use this method to retrieve information about a batch.  

**Note:** To retrieve a batch, you need its batchId. If you don't have the batchId, use our [List Batches](https://docs.payroc.com/api/schema/reporting/settlement/list-batches) method to search for the batch.  

Our gateway returns the following information about the batch:  

-	Transaction information, including the number of transactions and total value of sales.  
-	Merchant information, including the merchant ID (MID) and the processing account that the batch is associated with.

## Path parameters

- `batchId` integer, required

## Headers

- `Authorization` string, required

## Response `200`

Successful request. Returns the requested batch.

- Batch
  - `batchId` integer — Unique identifier that we assigned to the batch.
  - `date` string, date — Date that the merchant submitted the batch. The format of this value is **YYYY-MM-DD**.
  - `createdDate` string, date — Date that we created a record for the batch. The format of this value is **YYYY-MM-DD**.
  - `lastModifiedDate` string, date — Date that the batch was last changed. The format of this value is **YYYY-MM-DD**.
  - `saleAmount` integer — Total value of sales in the batch. We return the value in the currency's lowest denomination, for example, cents.
  - `heldAmount` integer — Total value of authorizations in the batch. We return the value in the currency's lowest denomination, for example, cents.
  - `returnAmount` integer — Total value of returns in the batch. We return the value in the currency's lowest denomination, for example, cents.
  - `transactionCount` integer — Total number of transactions in the batch.
  - `currency` string — Currency of the transactions in the batch. The value for the currency follows the [ISO 4217](https://www.iso.org/iso-4217-currency-codes.html) standard.
  - `merchant` MerchantSummary — Object that contains information about the merchant.
    - `merchantId` string — Unique identifier that the processor assigned to the merchant.
    - `doingBusinessAs` string — Trading name of the business.
    - `processingAccountId` integer — Unique identifier that we assigned to the processing account.
    - `link` Link — Object that contains HATEOAS links for the resource.
      - `rel` string, required — Indicates the relationship between the current resource and the target resource.
      - `method` string, required — HTTP method that you need to use with the target resource.
      - `href` string, required — URL of the target resource.
  - `links` Link[]
    - `rel` string, required — Indicates the relationship between the current resource and the target resource.
    - `method` string, required — HTTP method that you need to use with the target resource.
    - `href` string, required — URL of the target resource.

## Other responses

- `400` — Validation error
- `401` — Identity could not be verified
- `403` — Do not have permissions to perform this action
- `404` — Resource not found
- `406` — Not acceptable
- `500` — An error has occured

---

[API](https://skmtc.dev/payroc/apis/schema.md) · [All operations](https://skmtc.dev/payroc/apis/schema/llms.txt) · [OpenAPI document](https://skmtc-service-production.skmtc.workers.dev/v1/apis/payroc/schema/revisions/1d9d3e305945/schema)