---
title: "Get batch payment by ID"
method: GET
path: "/batchpayments/{id}"
tags: ["Payments"]
---

# Get batch payment by ID

`GET /batchpayments/{id}`

Get the details of an existing batch payment by ID

## Path parameters

- `id` string, required

## Response `200`

OK

- PaymentBatchPaymentDetailsResponse
  - `id` string — Unique id for the Batch Payment. 10 characters long
  - `externalReference` string — External reference, if provided
  - `status` 'ACCEPTED' | 'REJECTED' | 'SUBMITTED' | 'CANCELLED' — Current status of batch.
  - `totalPayments` integer — Total count of payments in this batch
  - `currentUserCanApprove` boolean — Whether the user is allowed to approve this batch, based on their approval limits, and applicable configuration
  - `paymentDetails` object — Summary of payments and approvals, per currency (as a 3-alpha currency code)
  - `approvals` PaymentPaymentApproval[] — List of batch-level approvals
    - `approvedBy` string — ID of user who approved this batch payment request
    - `approvedOn` string, date — Date this approval was applied
  - `currentUserCanCancel` boolean — Whether the user is allowed and currently able to cancel at least one of the payments in this batch
  - `createdDate` string, date-time — Datetime when the batch payment was created. Format is 'yyyy-MM-dd'T'HH:mm:ssZ' where Z is UTC offset. e.g 2017-01-28T01:01:01+0000
  - `createdBy` string — ID of the user that created the payment
  - `processingDateFrom` string, date — Earliest processing date in the batch file or the batch creation date if the file does not have any dates. Date format 'yyyy-MM-dd'
  - `processingDateTo` string, date — Last processing date in the batch file or empty if the file does not have any dates. Date format 'Format is 'yyyy-MM-dd'T'HH:mm:ssZ' where Z is UTC offset. e.g 2017-01-28T01:01:01+0000'
  - `earliestScheduledPaymentDate` string, date — Earliest processing date in the batch file or empty if the file does not have any dates. Date format 'Format is 'yyyy-MM-dd'T'HH:mm:ssZ' where Z is UTC offset. e.g 2017-01-28T01:01:01+0000'
  - `requiredApprovalCount` integer — The number of required approvals for the batch. Applicable to batch payments of submissionType BATCH
  - `batchSummary` PaymentBatchSummary
    - `total` integer — Total count of payment requests in this batch
    - `inprogress` integer — Count of payment requests in progress
    - `invalid` integer — Count of invalid payment requests
    - `errors` integer — Count of failed payment requests
    - `cancelled` integer — Count of cancelled payment requests
    - `completed` integer — Count of completed payments
    - `info` string — Additional information or error message regarding this batch payment request
  - `strict` boolean — Strict processing flag. Whether the entire batch should fail on any individual payment validation failure
  - `summary` PaymentBatchPaymentSummary
    - `total` integer — Total count of payment requests in this batch
    - `invalid` integer — Count of invalid payment requests
    - `inprogress` integer — Count of payment requests in progress
    - `completed` integer — Count of completed payments
    - `errors` integer — Count of failed payment requests
    - `cancelled` integer — Count of cancelled payment requests
    - `info` string — Additional information or error message regarding this batch payment request
    - `strict` boolean

## Other responses

- `400` — Bad Request

---

[API](https://skmtc.net/modulrfinance/apis/modulr-api.md) · [All operations](https://skmtc.net/modulrfinance/apis/modulr-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/modulrfinance/modulr-api/versions/cbd52524c8ef/schema)