---
title: Payment and check lookup
summary: Retrieves payments by invoice number or issue date, and checks by number, from Guidewire ClaimCenter.
status: draft
owner: SAIF.Core documentation team
last_reviewed: 2026-09-24
library: SAIF.Data.Guidewire
reference_type: package
operation_id: OP-SDG-05
trigger: Caller invokes a FinancialDataApiClient lookup method
---

# Payment and check lookup

This operation retrieves payment and check data from Guidewire ClaimCenter through `FinancialDataApiClient`, using the shared cached-request pipeline for all three lookup shapes.

| Field | Value |
| --- | --- |
| **Operation ID** | OP-SDG-05 |
| **Trigger** | Caller invokes a payment or check lookup method on `FinancialDataApiClient` |
| **Inputs** | Invoice number, issue date, zero-pay inclusion flag, check number |
| **Outputs** | `PaymentsResponse` or `CheckFinancialData` |
| **Primary components** | `FinancialDataApiClient` |
| **Entry point** | `Data/SAIF.Data.Guidewire/Clients/FinancialDataApiClient.cs` |

## Steps

1. Resolve the client's base URL (`cc.financial.api.url.v1`) and Basic-auth header (`cc.gwcreds`).

   > **Origin**: Step 1 is implemented in [Resolve base URL and authenticate](resolve-base-url-and-authenticate.md) (`SAIF.Data.Guidewire`) and executed on behalf of this operation.
2. Payments by invoice number: GET `payments?invoiceNumber={n}`, executed through the cached-request helper. ([SDG-BR-003](../business-rules.md#sdg-br-003-responses-cached-unless-caching-is-disabled))
3. Payments by issue date: GET `payments?issueDate={yyyy-MM-dd}`.
   - If zero-pay payments are requested: append `&includeZeroPays=true` (lowercase) to the query string. ([SDG-BR-013](../business-rules.md#sdg-br-013-zero-pay-payments-included-only-when-requested))
   - Otherwise: omit the parameter.
4. Check by number: GET `checks/{checkNumber}`, executed through the cached-request helper. ([SDG-BR-003](../business-rules.md#sdg-br-003-responses-cached-unless-caching-is-disabled))

## Process flow

The following diagram visualizes this operation's control flow.

```mermaid
flowchart TD
	Start([Caller invokes a lookup method]) --> S1["Resolve base URL and<br>Basic-auth header"]
	S1 --> Which{"Which lookup?"}
	Which -->|By invoice number| S2["GET payments?invoiceNumber={n}"]
	Which -->|By issue date| S3{"includeZeroPays<br>requested?"}
	S3 -->|Yes| S3a["GET payments?issueDate={date}<br>&includeZeroPays=true"]
	S3 -->|No| S3b["GET payments?issueDate={date}"]
	Which -->|By check number| S4["GET checks/{checkNumber}"]
	S2 --> EndOk([Return cached/deserialized response])
	S3a --> EndOk
	S3b --> EndOk
	S4 --> EndOk
```

## Failure and edge-case behavior
- Zero-pay payments are excluded from a payments-by-issue-date response unless the caller explicitly requests them ([SDG-BR-013](../business-rules.md#sdg-br-013-zero-pay-payments-included-only-when-requested)).

## Related documentation
- [Operations and processes](../operations-processes.md)
- [Business rules](../business-rules.md)

## Sources
- `Data/SAIF.Data.Guidewire/Clients/FinancialDataApiClient.cs`
- `Data/SAIF.Data.Guidewire/Models/FinancialDataApi/PaymentsResponse.cs`
- `Data/SAIF.Data.Guidewire/Models/FinancialDataApi/CheckFinancialData.cs`