---
title: "Detalhe do lote de pagamento"
method: GET
path: "/{companyId}/banking/payroll/payments/{paymentId}"
tags: ["Pagamentos"]
---

# Detalhe do lote de pagamento

`GET /{companyId}/banking/payroll/payments/{paymentId}`

Retorna o detalhe completo de um lote de pagamento, incluindo status individual de cada item.

**Estados terminais:** `settled` · `failed` · `cancelled`

## Path parameters

- `companyId` string, required
- `paymentId` integer, required

## Query parameters

- `companyTaxIds` string[]

## Response `200`

OK

- PayrollBatchDetailDto
  - `paymentId` integer
  - `description` string, nullable
  - `status` string, nullable
  - `debitParty` PayrollBatchDetailDebitPartyDto
    - `branchCode` string, nullable
    - `number` string, nullable
  - `submittedAt` string, date-time, nullable
  - `approvedAt` string, date-time, nullable
  - `settledAt` string, date-time, nullable
  - `cancelledAt` string, date-time, nullable
  - `scheduledDate` string, date-time, nullable
  - `totalEmployees` integer
  - `totalAmount` number, double
  - `settledCount` integer
  - `failedCount` integer
  - `items` PayrollBatchDetailItemDto[], nullable
    - `employeeId` string, nullable
    - `name` string, nullable
    - `taxId` string, nullable
    - `line` integer, nullable
    - `cnab240SegmentATransactionId` integer, nullable
    - `paymentType` string, nullable
    - `netAmount` number, double
    - `status` string, nullable
    - `transactionStatus` string, nullable
    - `transactionError` string, nullable
    - `settledAt` string, date-time, nullable
    - `failureReason` string, nullable
  - `links` PayrollBatchDetailLinksDto
    - `self` PayrollLinkDto
      - `href` string, nullable
    - `cancel` PayrollLinkDto
      - `href` string, nullable

---

[API](https://skmtc.net/btgpactual/apis/folha-de-pagamentos.md) · [All operations](https://skmtc.net/btgpactual/apis/folha-de-pagamentos/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/btgpactual/folha-de-pagamentos/revisions/2a24d3da114c/schema)
