Skip to content

Add remittanceInformation field to the quotes API#675

Closed
ls-bolt[bot] wants to merge 1 commit into
mainfrom
07-09-grid-quotes-remittance-info
Closed

Add remittanceInformation field to the quotes API#675
ls-bolt[bot] wants to merge 1 commit into
mainfrom
07-09-grid-quotes-remittance-info

Conversation

@ls-bolt

@ls-bolt ls-bolt Bot commented Jul 9, 2026

Copy link
Copy Markdown

This PR has been claimed. The active PR is now #676.

Summary

Adds remittanceInformation as a field on the Grid quotes API so free-form remittance information can be captured when a quote is created and passed through the quotes flow.

  • QuoteRequest (input) — new optional remittanceInformation string. Captures the free-form info that travels with the payment to the recipient.
  • Quote (response) — echoes remittanceInformation back so the value provided on the request is visible throughout the quote lifecycle.

The definition mirrors the existing remittanceInformation field on the transfer-out API (TransferOutRequest): free-form string, maxLength: 80, with a rail-specific description — for ACH it populates the Addenda record, for FedNow and RTP the remittanceInformation field, and for wires the OBI (Originator to Beneficiary Information) / beneficiary information.

Changes

  • openapi/components/schemas/quotes/QuoteRequest.yaml — add remittanceInformation property
  • openapi/components/schemas/quotes/Quote.yaml — add remittanceInformation property
  • openapi.yaml + mintlify/openapi.yaml — regenerated bundles (make build)

Test plan

  • make build — rebundled cleanly
  • make lint-openapi — passes (Woohoo! Your API description is valid. 🎉, exit 0); remaining output is pre-existing info/warning noise on unrelated schemas
  • Codex pre-PR review — no findings

Public

The quotes API now accepts and returns remittanceInformation, letting payment reference text be attached at quote time and carried through the flow.

Requested by @shreyav

Slack thread: https://lightsparkgroup.slack.com/archives/D0AH5T8FMGE/p1783639688002849


🤖 humming-aether(#1) | Feedback

Capture free-form remittance information on the quote request and echo it
back on the quote response so it flows through the quotes lifecycle. Mirrors
the existing remittanceInformation field on the transfer-out API (free-form,
maxLength 80, rail-specific: ACH Addenda / RTP+FedNow remittanceInformation /
wire OBI).
@vercel

vercel Bot commented Jul 9, 2026

Copy link
Copy Markdown

The latest updates on your projects. Learn more about Vercel for GitHub.

2 Skipped Deployments
Project Deployment Actions Updated (UTC)
grid-flow-builder Ignored Ignored Preview Jul 9, 2026 11:35pm
grid-wallet-demo Ignored Ignored Preview Jul 9, 2026 11:35pm

Request Review

@ls-bolt ls-bolt Bot added the bolt label Jul 9, 2026

akanter commented Jul 9, 2026

Copy link
Copy Markdown
Contributor

This stack of pull requests is managed by Graphite. Learn more about stacking.

@github-actions

github-actions Bot commented Jul 9, 2026

Copy link
Copy Markdown
Contributor

✱ Stainless preview builds for grid

This PR will update the grid SDKs with the following commit messages.

cli

feat(api): add remittance_information parameter to quote creation methods

go

feat(api): add remittanceInformation field to quotes

kotlin

feat(api): add remittanceInformation field to quotes

openapi

feat(api): add remittanceInformation field to quote and transfer schemas

php

feat(api): add remittanceInformation parameter to quotes

python

feat(api): add remittance_information parameter and field to quotes

ruby

feat(api): add remittance_information field to quotes

typescript

feat(api): add remittanceInformation parameter and field to quotes

Edit this comment to update them. They will appear in their respective SDK's changelogs.

grid-cli studio · code · diff

Your SDK build had at least one "warning" diagnostic, but this did not represent a regression.
generate ⚠️build ❗lint ❗test ❗

grid-openapi studio · code · diff

Your SDK build had at least one "warning" diagnostic, but this did not represent a regression.
generate ⚠️

grid-go studio · code · diff

Your SDK build had at least one "note" diagnostic, but this did not represent a regression.
generate ✅build ✅lint ❗test ❗

go get github.com/stainless-sdks/grid-go@06d553012352622462c2ca575d2a113eb53c4bd6
grid-kotlin studio · code · diff

Your SDK build had at least one "warning" diagnostic, but this did not represent a regression.
generate ⚠️build ✅lint ✅test ❗

grid-ruby studio · code · diff

Your SDK build had at least one "note" diagnostic, but this did not represent a regression.
generate ✅build ✅lint ✅test ✅

grid-python studio · code · diff

Your SDK build had at least one "note" diagnostic, but this did not represent a regression.
generate ✅build ✅lint ❗test ❗

pip install https://pkg.stainless.com/s/grid-python/eeb24415157a8b05374d7cac8c97e15818f96410/grid-0.0.1-py3-none-any.whl
grid-typescript studio · code · diff

Your SDK build had at least one "note" diagnostic, but this did not represent a regression.
generate ✅build ✅lint ❗test ✅

npm install https://pkg.stainless.com/s/grid-typescript/ec47fca919ebd9d45a33c0af8213d321be0df9f0/dist.tar.gz
grid-php studio · code · diff

Your SDK build had at least one "note" diagnostic, but this did not represent a regression.
generate ✅lint ✅test ✅


This comment is auto-generated by GitHub Actions and is automatically kept up to date as you push.
If you push custom code to the preview branch, re-run this workflow to update the comment.
Last updated: 2026-07-09 23:40:06 UTC

@shreyav shreyav marked this pull request as ready for review July 10, 2026 00:25
@shreyav shreyav closed this Jul 10, 2026
@greptile-apps

greptile-apps Bot commented Jul 10, 2026

Copy link
Copy Markdown
Contributor

Greptile Summary

This PR adds remittance information to the quotes API. The main changes are:

  • Optional remittanceInformation on quote creation requests.
  • Optional remittanceInformation on quote responses.
  • Regenerated OpenAPI bundles for the root and Mintlify specs.

Confidence Score: 5/5

This looks safe to merge after checking the quote implementation matches the new schema.

  • The schema shape matches the existing transfer-out remittance field.
  • The remaining concerns are conditional on backend validation and response propagation outside this diff.
  • No blocking issue was found in the changed OpenAPI files.

openapi/components/schemas/quotes/QuoteRequest.yaml and openapi/components/schemas/quotes/Quote.yaml

Important Files Changed

Filename Overview
openapi/components/schemas/quotes/QuoteRequest.yaml Adds an optional remittanceInformation request field with an 80-character limit.
openapi/components/schemas/quotes/Quote.yaml Adds an optional remittanceInformation response field that describes echoing the request value.
openapi.yaml Regenerated bundled OpenAPI spec with the new quote fields.
mintlify/openapi.yaml Regenerated Mintlify OpenAPI spec with the new quote fields.
Prompt To Fix All With AI
Fix the following 2 code review issues. Work through them one at a time, proposing concise fixes.

---

### Issue 1 of 2
openapi/components/schemas/quotes/Quote.yaml:115-125
**Response Field Can Stay Empty**

When a client sends `remittanceInformation` on quote creation, this response description says the quote returns the value from the request. If the quote backend is not also storing and echoing this field, generated clients can treat the field as supported while every quote response omits it.

### Issue 2 of 2
openapi/components/schemas/quotes/QuoteRequest.yaml:58-67
**Length Limit Needs Enforcement**

This schema caps `remittanceInformation` at 80 characters, which matches the downstream rail descriptions. If quote creation does not validate the same limit before execution, a longer value can be accepted at quote time and later fail or be truncated when the payment is sent.

Reviews (1): Last reviewed commit: "Add remittanceInformation field to the q..." | Re-trigger Greptile

Comment on lines +115 to +125
remittanceInformation:
type: string
maxLength: 80
description: >-
Free-form information about the payment that travels with it to the
recipient, as provided on the quote request. The field this populates
depends on the payment rail: for ACH it populates the Addenda record, for
FedNow and RTP it populates the remittanceInformation field, and for wires
it populates the OBI (Originator to Beneficiary Information) / beneficiary
information.
example: '12345'

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

P2 Response Field Can Stay Empty

When a client sends remittanceInformation on quote creation, this response description says the quote returns the value from the request. If the quote backend is not also storing and echoing this field, generated clients can treat the field as supported while every quote response omits it.

Prompt To Fix With AI
This is a comment left during a code review.
Path: openapi/components/schemas/quotes/Quote.yaml
Line: 115-125

Comment:
**Response Field Can Stay Empty**

When a client sends `remittanceInformation` on quote creation, this response description says the quote returns the value from the request. If the quote backend is not also storing and echoing this field, generated clients can treat the field as supported while every quote response omits it.

How can I resolve this? If you propose a fix, please make it concise.

Note: If this suggestion doesn't match your team's coding style, reply to this and let me know. I'll remember it for next time!

Comment on lines +58 to +67
remittanceInformation:
type: string
maxLength: 80
description: >-
Free-form information about the payment that travels with it to the
recipient. The field this populates depends on the payment rail: for ACH
it populates the Addenda record, for FedNow and RTP it populates the
remittanceInformation field, and for wires it populates the OBI
(Originator to Beneficiary Information) / beneficiary information.
example: '12345'

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

P2 Length Limit Needs Enforcement

This schema caps remittanceInformation at 80 characters, which matches the downstream rail descriptions. If quote creation does not validate the same limit before execution, a longer value can be accepted at quote time and later fail or be truncated when the payment is sent.

Prompt To Fix With AI
This is a comment left during a code review.
Path: openapi/components/schemas/quotes/QuoteRequest.yaml
Line: 58-67

Comment:
**Length Limit Needs Enforcement**

This schema caps `remittanceInformation` at 80 characters, which matches the downstream rail descriptions. If quote creation does not validate the same limit before execution, a longer value can be accepted at quote time and later fail or be truncated when the payment is sent.

How can I resolve this? If you propose a fix, please make it concise.

shreyav added a commit that referenced this pull request Jul 10, 2026
## Summary

Adds `remittanceInformation` as a field on the Grid **quotes API** so
free-form remittance information can be captured when a quote is created
and passed through the quotes flow.

- **`QuoteRequest`** (input) — new optional `remittanceInformation`
string. Captures the free-form info that travels with the payment to the
recipient.
- **`Quote`** (response) — echoes `remittanceInformation` back so the
value provided on the request is visible throughout the quote lifecycle.

The definition mirrors the existing `remittanceInformation` field on the
transfer-out API (`TransferOutRequest`): free-form string, `maxLength:
80`, with a rail-specific description — for ACH it populates the Addenda
record, for FedNow and RTP the `remittanceInformation` field, and for
wires the OBI (Originator to Beneficiary Information) / beneficiary
information.

## Changes
- `openapi/components/schemas/quotes/QuoteRequest.yaml` — add
`remittanceInformation` property
- `openapi/components/schemas/quotes/Quote.yaml` — add
`remittanceInformation` property
- `openapi.yaml` + `mintlify/openapi.yaml` — regenerated bundles (`make
build`)

## Test plan
- `make build` — rebundled cleanly
- `make lint-openapi` — passes (`Woohoo! Your API description is valid.
🎉`, exit 0); remaining output is pre-existing info/warning noise on
unrelated schemas
- Codex pre-PR review — no findings

## Public
The quotes API now accepts and returns `remittanceInformation`, letting
payment reference text be attached at quote time and carried through the
flow.

Requested by @shreyav

Slack thread:
https://lightsparkgroup.slack.com/archives/D0AH5T8FMGE/p1783639688002849

---
🤖
[humming-aether](https://zeus.dev.dev.sparkinfra.net/#/arc?id=humming-aether)[(#1)](https://zeus.dev.dev.sparkinfra.net/#/instance?id=humming-aether)
| [Feedback](https://zeus.dev.dev.sparkinfra.net/feedback)

Original PR: #675
@shreyav shreyav deleted the 07-09-grid-quotes-remittance-info branch July 10, 2026 00:37
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants