feat(transfers): add remittanceInformation to transfer-out request

[pengying]

Summary

Adds an optional remittanceInformation field to the transfer-out request body (POST /transfers/transfer-out).

The field that this value populates depends on the payment rail:

• ACH → Addenda record
• FedNow / RTP → remittanceInformation field
• Wires → OBI (Originator to Beneficiary Information) / beneficiary information

Changes

• Added remittanceInformation (string, optional) to TransferOutRequest.yaml with a rail-specific description
• Added the field to the request example in transfer_out.yaml
• Rebundled openapi.yaml and mintlify/openapi.yaml via make build

🤖 Generated with Claude Code

[vercel]

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

Project	Deployment	Actions	Updated (UTC)
grid-flow-builder	Ready	Preview, Comment	Jun 4, 2026 8:07pm

[pengying]

• feat(transfers): add remittanceInformation to transfer-out request #538 👈 (View in Graphite)
• main

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

[github-actions]

✱ 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 transfer out creation

csharp

feat(api): add remittance_information parameter to me/transfer_out create methods

go

feat(api): add remittance_information parameter to transfer out request

kotlin

feat(api): add remittanceInformation field to transfer out request

openapi

feat(api): add remittanceInformation parameter to transfer-out request

php

feat(api): add remittanceInformation parameter to transfer out methods

python

feat(api): add remittance_information parameter to transfer out methods

ruby

feat(api): add remittance_information parameter to transfer_out methods

typescript

feat(api): add remittanceInformation param to transferOut and agents.me methods

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-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@b9c0e6ac8cb43c170b90ef7536ee018d4a3b459f

✅ grid-openapi studio · code · diff

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

✅ 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/bf5fd7bb8918ed4766c40d2b0204eccc595efc2c/grid-0.0.1-py3-none-any.whl

⚠️ grid-kotlin studio · code · diff

Your SDK build had a failure in the test CI job, which is a regression from the base state.
generate ✅ → build ✅ → lint ✅ → test ❗ (prev: test ✅)

✅ grid-csharp studio · code · diff

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

✅ grid-php studio · code · diff

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

✅ 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/ab2d7584a93f75249fb2055a595069ab7d200147/dist.tar.gz

---

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-06-04 20:13:35 UTC

[greptile-apps]

Greptile Summary

This PR adds an optional remittanceInformation string field (with maxLength: 80) to the TransferOutRequest schema, allowing clients to attach payment notes that are forwarded to recipients on the appropriate rail-specific field. The source schema, path example, and both generated bundles are updated consistently.

• Added remittanceInformation (string, optional, maxLength: 80) to TransferOutRequest.yaml with a rail-specific description covering ACH addenda, FedNow/RTP, and wire OBI.
• Updated the transfer_out.yaml path example and rebundled openapi.yaml and mintlify/openapi.yaml via make build.

Confidence Score: 5/5

Safe to merge — adds a single optional field with a clear constraint and no breaking changes to existing consumers.

The change is purely additive: an optional string field with a validated maxLength applied at the schema level. Existing requests without the field continue to work, and the source schema, path example, and both generated bundles are all updated consistently.

No files require special attention.

Important Files Changed

Filename	Overview
openapi/components/schemas/transfers/TransferOutRequest.yaml	Adds optional remittanceInformation string field with maxLength: 80 and a clear rail-specific description; source-of-truth schema is correctly edited here.
openapi/paths/transfers/transfer_out.yaml	Adds remittanceInformation example to the POST request; consistent with the schema change.
openapi.yaml	Generated bundle reflecting the new field; diff is consistent with the source changes in openapi/.
mintlify/openapi.yaml	Mintlify-specific generated bundle; identical changes to openapi.yaml, as expected from make build.

Sequence Diagram

sequenceDiagram
    participant Client
    participant GridAPI as Grid API
    participant Rail as Payment Rail
    Client->>GridAPI: POST /transfers/transfer-out with remittanceInformation
    Note over GridAPI: Validate maxLength 80
    alt ACH
        GridAPI->>Rail: Payment + Addenda record
    else FedNow / RTP
        GridAPI->>Rail: Payment + remittanceInformation field
    else Wire
        GridAPI->>Rail: Payment + OBI info
    end
    Rail-->>GridAPI: Confirmation
    GridAPI-->>Client: 201 Created

Loading

_{Reviews (6): Last reviewed commit: "Merge branch 'main' into 06-02-feat_tran..." | Re-trigger Greptile}