---
title: PaymentsResponse
summary: API reference for PaymentsResponse.
status: draft
owner: SAIF.Core documentation team
last_reviewed: 2026-09-24
library: SAIF.Data.Guidewire
reference_type: package
---

# PaymentsResponse

PaymentsResponse is the response payload returned by [FinancialDataApiClient](../SAIF.Data.Guidewire.Clients/FinancialDataApiClient.md)'s payments-by-invoice-number and payments-by-issue-date lookups, wrapping a list of [PaymentsResponsePayment](PaymentsResponsePayment.md) records. It has no attributes and relies on default JSON property-name serialization.

## Purpose
- Wraps the collection of payment records returned by a payments lookup query

## Context
- Namespace: `SAIF.Data.Guidewire.Models.FinancialDataApi`
- Assembly/package: `SAIF.Data.Guidewire` (packaged in `SAIF.SAIFCode.Core`)

## Public members
| Member | Signature | Purpose |
| --- | --- | --- |
| Payments | `public List<PaymentsResponsePayment> Payments { get; set; }` | The payment records returned by the lookup |

## Behavioral notes
- Returned by [FinancialDataApiClient](../SAIF.Data.Guidewire.Clients/FinancialDataApiClient.md)'s payments-by-invoice-number and payments-by-issue-date lookup methods.
- For payments-by-issue-date lookups, zero-pay payments are included in this response only when the caller explicitly requests them ([SDG-BR-013](../../business-rules.md#sdg-br-013-zero-pay-payments-included-only-when-requested)).

## Sources
- Data/SAIF.Data.Guidewire/Models/FinancialDataApi/PaymentsResponse.cs