> ## Documentation Index > Fetch the complete documentation index at: https://docs.maxcare.ai/llms.txt > Use this file to discover all available pages before exploring further. # List ERA payments > One row per payer check or EFT: trace number (835 TRN02), check total, dates, payer, the platform's bank reconciliation status and the deposits linked to it. Match a deposit to a remittance by comparing `checkNumber` with the deposit's `bankRefId`. Offset-paged and ordered by when the platform first stored the payment; there is no `updatedSince` here. Totals are counted on every page. Requires read:era_payments. Facility-limited API keys are refused. ## OpenAPI ````yaml /openapi-v4.json get /era-payments openapi: 3.0.0 info: title: Max AI Public API description: API for third-party marketplace apps version: '4.0' contact: {} servers: - url: https://api.maxcare.ai/v4 security: [] tags: [] paths: /era-payments: get: tags: - ERA Payments summary: List ERA payments description: >- One row per payer check or EFT: trace number (835 TRN02), check total, dates, payer, the platform's bank reconciliation status and the deposits linked to it. Match a deposit to a remittance by comparing `checkNumber` with the deposit's `bankRefId`. Offset-paged and ordered by when the platform first stored the payment; there is no `updatedSince` here. Totals are counted on every page. Requires read:era_payments. Facility-limited API keys are refused. operationId: EraPaymentsPublicController_listEraPayments parameters: - name: page required: false in: query description: Page number (1-indexed) schema: default: 1 example: 1 - name: pageSize required: false in: query description: Number of items per page (max 100) schema: default: 100 example: 100 - name: checkNumber required: false in: query description: Exact check or EFT trace number (835 TRN02), as the payer sent it. schema: example: '000000481' type: string - name: bankTransactionId required: false in: query description: >- Only ERA payments linked to this deposit (`btx_…`) by the platform's reconciliation (pending or confirmed/manual). A deposit outside your organization is a 404. schema: example: btx_5f1c0000000040000000000000000001 type: string - name: checkDateFrom required: false in: query description: >- Check date on/after this day (YYYY-MM-DD, UTC). Excludes payments with no check date. schema: example: '2026-10-01' type: string - name: checkDateTo required: false in: query description: >- Check date on/before this day, inclusive (YYYY-MM-DD, UTC). Excludes payments with no check date. schema: example: '2026-10-31' type: string - name: depositDateFrom required: false in: query description: >- EHR deposit date on/after this day (YYYY-MM-DD, UTC). See `depositDate` for what it means. schema: example: '2026-10-01' type: string - name: depositDateTo required: false in: query description: EHR deposit date on/before this day, inclusive (YYYY-MM-DD, UTC). schema: example: '2026-10-31' type: string - name: X-Organization-Id in: header required: true schema: type: string description: Target clinic organization ID responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/ListEraPaymentsSuccessResponse' '400': description: Missing or invalid request parameter content: application/json: schema: $ref: '#/components/schemas/PublicApiBadRequestResponse' '401': description: Invalid or missing API key content: application/json: schema: $ref: '#/components/schemas/PublicApiUnauthorizedResponse' '403': description: Insufficient scope content: application/json: schema: $ref: '#/components/schemas/PublicApiForbiddenResponse' '404': description: Resource not found content: application/json: schema: $ref: '#/components/schemas/PublicApiNotFoundResponse' '429': description: Rate limit exceeded content: application/json: schema: $ref: '#/components/schemas/PublicApiRateLimitResponse' security: - api-key: [] components: schemas: ListEraPaymentsSuccessResponse: type: object properties: code: type: string description: Response code example: success data: $ref: '#/components/schemas/ListEraPaymentsResponseData' required: - code - data PublicApiBadRequestResponse: type: object properties: code: type: string description: Error code example: bad_request message: type: string description: Human-readable error message example: '''id'' must be a valid UUID' trace_id: type: string description: Trace ID for debugging example: 550e8400-e29b-41d4-a716-446655440000 required: - code - message - trace_id PublicApiUnauthorizedResponse: type: object properties: code: type: string description: Error code example: unauthorized message: type: string description: Human-readable error message example: Invalid or missing API key trace_id: type: string description: Trace ID for debugging example: 550e8400-e29b-41d4-a716-446655440000 required: - code - message - trace_id PublicApiForbiddenResponse: type: object properties: code: type: string description: Error code example: forbidden message: type: string description: Human-readable error message example: Insufficient scope trace_id: type: string description: Trace ID for debugging example: 550e8400-e29b-41d4-a716-446655440000 required: - code - message - trace_id PublicApiNotFoundResponse: type: object properties: code: type: string description: Error code example: not_found message: type: string description: Human-readable error message example: Resource not found trace_id: type: string description: Trace ID for debugging example: 550e8400-e29b-41d4-a716-446655440000 required: - code - message - trace_id PublicApiRateLimitResponse: type: object properties: code: type: string description: Error code example: rate_limit_exceeded message: type: string description: Human-readable error message example: Rate limit exceeded. Maximum 1000 requests per 60 seconds. trace_id: type: string description: Trace ID for debugging example: 550e8400-e29b-41d4-a716-446655440000 required: - code - message - trace_id ListEraPaymentsResponseData: type: object properties: eraPayments: type: array items: $ref: '#/components/schemas/ExternalEraPaymentResponse' pagination: $ref: '#/components/schemas/PaginationInfoResponse' required: - eraPayments - pagination ExternalEraPaymentResponse: type: object properties: id: type: string description: >- ERA payment ID: one check or EFT. `GET /v4/era-service-lines?eraPaymentId=` lists what it paid. ModMed's unposted -> posted transition can re-key it. example: erp_5f1c0000000040000000000000000003 checkNumber: type: string nullable: true description: >- Check or EFT trace number (835 TRN02). Compare with a deposit's `bankRefId` to match a remittance to the money. Not unique across payers. Null when the EHR recorded none (common on keyed-in paper EOBs). example: '000000481' checkAmount: type: string nullable: true description: >- Check total (835 BPR02), already net of provider-level adjustments (PLB): the amount that should reach the bank. It need not equal the sum of the claims' payments. Decimal string; null when not reported. example: '28412.60' originalAmount: type: string nullable: true description: >- The payer's original payment amount before omissions (ModMed). `0.00` with a non-zero `checkAmount` means no real money moved (e.g. a portion posted under another EHR instance). Null when the EHR does not report it (EZDerm and older rows). example: '28412.60' paymentType: type: string nullable: true description: >- Payment type as the EHR reports it, such as EFT, CHECK or ACH. Free text, not normalized. example: ACH paymentMethod: type: string nullable: true description: >- Payment method or processor as the EHR reports it. Free text, not normalized. example: null checkDate: type: string nullable: true description: >- Date on the check or EFT (YYYY-MM-DD). Null when the EHR recorded none. example: '2026-10-09' depositDate: type: string nullable: true description: >- Deposit date as the EHR records it (YYYY-MM-DD), NOT a bank fact. On a ModMed ERA that is not posted yet it is a placeholder for posting, not a deposit. For the actual deposit, follow `bankTransactionIds`. example: '2026-10-14' isEra: type: boolean description: >- True for an 835 remittance, false for a keyed-in paper EOB. Null on rows that never recorded it. nullable: true example: true payer: nullable: true description: Null when the ERA names no resolved payer allOf: - $ref: '#/components/schemas/EraPaymentPayer' reconciliationStatus: type: string description: >- The platform's bank reconciliation of this payment: `unmatched`, `pending` (linked to a deposit, awaiting review) or `reconciled` (a biller confirmed the deposit). example: reconciled bankTransactionIds: description: >- Deposits (`btx_…`) the platform linked to this payment, pending or confirmed/manual. example: - btx_5f1c0000000040000000000000000001 type: array items: type: string required: - id - checkNumber - checkAmount - originalAmount - paymentType - paymentMethod - checkDate - depositDate - isEra - payer - reconciliationStatus - bankTransactionIds PaginationInfoResponse: type: object properties: page: type: number description: Current page number example: 1 pageSize: type: number description: Items per page example: 100 totalCount: type: number description: Total number of items example: 250 totalPages: type: number description: Total number of pages example: 3 required: - page - pageSize - totalCount - totalPages EraPaymentPayer: type: object properties: id: type: string nullable: true description: MaxAI payer UUID (raw UUID), matching /payers/{id} example: 10000000-0000-4000-8000-000000000002 name: type: string nullable: true example: Synthetic Health Plan required: - id - name securitySchemes: api-key: scheme: bearer bearerFormat: JWT type: http description: Marketplace API key ```` This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.