Add remittanceInformation field to the quotes API#675
Conversation
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).
|
The latest updates on your projects. Learn more about Vercel for GitHub. 2 Skipped Deployments
|
✱ Stainless preview builds for gridThis PR will update the cli go kotlin openapi php python ruby typescript Edit this comment to update them. They will appear in their respective SDK's changelogs. ✅ grid-cli studio · code · diff
✅ grid-openapi studio · code · diff
✅ grid-go studio · code · diff
✅ grid-kotlin studio · code · diff
✅ grid-ruby studio · code · diff
✅ grid-python studio · code · diff
✅ grid-typescript studio · code · diff
✅ grid-php studio · code · diff
This comment is auto-generated by GitHub Actions and is automatically kept up to date as you push. |
Greptile SummaryThis PR adds remittance information to the quotes API. The main changes are:
Confidence Score: 5/5This looks safe to merge after checking the quote implementation matches the new schema.
openapi/components/schemas/quotes/QuoteRequest.yaml and openapi/components/schemas/quotes/Quote.yaml
|
| 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
| 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' |
There was a problem hiding this comment.
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!
| 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' |
There was a problem hiding this 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.
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.## 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

Summary
Adds
remittanceInformationas 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 optionalremittanceInformationstring. Captures the free-form info that travels with the payment to the recipient.Quote(response) — echoesremittanceInformationback so the value provided on the request is visible throughout the quote lifecycle.The definition mirrors the existing
remittanceInformationfield 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 theremittanceInformationfield, and for wires the OBI (Originator to Beneficiary Information) / beneficiary information.Changes
openapi/components/schemas/quotes/QuoteRequest.yaml— addremittanceInformationpropertyopenapi/components/schemas/quotes/Quote.yaml— addremittanceInformationpropertyopenapi.yaml+mintlify/openapi.yaml— regenerated bundles (make build)Test plan
make build— rebundled cleanlymake lint-openapi— passes (Woohoo! Your API description is valid. 🎉, exit 0); remaining output is pre-existing info/warning noise on unrelated schemasPublic
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