feat(transfers): add remittanceInformation to transfer-out request#538
feat(transfers): add remittanceInformation to transfer-out request#538pengying wants to merge 1 commit into
Conversation
|
The latest updates on your projects. Learn more about Vercel for GitHub. 1 Skipped Deployment
|
✱ Stainless preview builds for gridThis PR will update the cli csharp go kotlin openapi php python ruby typescript Edit this comment to update them. They will appear in their respective SDK's changelogs. ✅ grid-openapi studio · code · diff
✅ grid-ruby studio · code · diff
✅ grid-kotlin studio · code · diff
✅ grid-typescript studio · code · diff
✅ grid-python studio · code · diff
✅ grid-csharp studio · code · diff
✅ grid-go studio · code · diff
✅ grid-php studio · code · diff
✅ grid-cli studio · code · diff
This comment is auto-generated by GitHub Actions and is automatically kept up to date as you push. |
Greptile SummaryAdds an optional
Confidence Score: 5/5This is a purely additive, backward-compatible schema change — existing clients are unaffected and the new optional field is consistent across all four touched files. The change adds a single optional string field with a conservative character cap to the transfer-out request. The source schema, path example, and both bundled specs are in sync. No required fields, response shapes, or existing behavior are modified. No files require special attention.
|
| Filename | Overview |
|---|---|
| openapi/components/schemas/transfers/TransferOutRequest.yaml | Adds optional remittanceInformation string field with maxLength: 80 to the transfer-out schema; description explains per-rail behavior (ACH addenda, FedNow/RTP field, wire OBI). |
| openapi/paths/transfers/transfer_out.yaml | Updates the inline request example to include remittanceInformation: '12345'; no other changes. |
| openapi.yaml | Bundled output — mirrors the source-file changes; adds remittanceInformation to the TransferOutRequest component and updates the path example. |
| mintlify/openapi.yaml | Bundled output for Mintlify docs — identical changes to openapi.yaml; correctly in sync with the source spec. |
Flowchart
%%{init: {'theme': 'neutral'}}%%
flowchart TD
A["POST /transfers/transfer-out\n{ remittanceInformation: string (≤80 chars) }"] --> B{Payment Rail?}
B -->|ACH| C["Addenda Record\n(NACHA: 80-char limit)"]
B -->|FedNow / RTP| D["remittanceInformation field\n(rail supports 140 chars; API caps at 80)"]
B -->|Wire| E["OBI — Originator to Beneficiary Info\n(rail supports 140 chars; API caps at 80)"]
B -->|Other / not provided| F["Field ignored / not applicable"]
Reviews (5): Last reviewed commit: "feat(transfers): add remittanceInformati..." | Re-trigger Greptile
95f76ee to
9a349d3
Compare
| 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 (max 80 characters), for FedNow and RTP | ||
| it populates the remittanceInformation field (max 140 characters), and for | ||
| wires it populates the OBI (Originator to Beneficiary Information) / | ||
| beneficiary information (max 140 characters). |
There was a problem hiding this comment.
Description contradicts enforced
maxLength
The schema enforces maxLength: 80, but the description explicitly tells clients that FedNow/RTP and wire transfers support up to 140 characters. Any client that reads the description and sends a 100-character remittance note for a wire transfer will receive a schema-validation rejection — even though the underlying rail accepts it. The description should be updated to accurately reflect the 80-character API limit, or maxLength should be raised to 140 with per-rail enforcement happening server-side.
Prompt To Fix With AI
This is a comment left during a code review.
Path: openapi/components/schemas/transfers/TransferOutRequest.yaml
Line: 21-28
Comment:
**Description contradicts enforced `maxLength`**
The schema enforces `maxLength: 80`, but the description explicitly tells clients that FedNow/RTP and wire transfers support up to 140 characters. Any client that reads the description and sends a 100-character remittance note for a wire transfer will receive a schema-validation rejection — even though the underlying rail accepts it. The description should be updated to accurately reflect the 80-character API limit, or `maxLength` should be raised to 140 with per-rail enforcement happening server-side.
How can I resolve this? If you propose a fix, please make it concise.9a349d3 to
f571cfe
Compare
Add an optional remittanceInformation field (max 80 chars) to the transfer-out request body. The field this populates depends on the payment rail: ACH populates the Addenda record (max 80 chars), FedNow/RTP populate remittanceInformation (max 140 chars), and wires populate the OBI / beneficiary information (max 140 chars). Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
f571cfe to
c199bf2
Compare

Summary
Adds an optional
remittanceInformationfield to the transfer-out request body (POST /transfers/transfer-out).The field that this value populates depends on the payment rail:
remittanceInformationfieldChanges
remittanceInformation(string, optional) toTransferOutRequest.yamlwith a rail-specific descriptiontransfer_out.yamlopenapi.yamlandmintlify/openapi.yamlviamake build🤖 Generated with Claude Code