Skip to content

docs: document remittanceInformation field for transfer-out#624

Open
claude[bot] wants to merge 2 commits into
mainfrom
docs/sync-20260626
Open

docs: document remittanceInformation field for transfer-out#624
claude[bot] wants to merge 2 commits into
mainfrom
docs/sync-20260626

Conversation

@claude

@claude claude Bot commented Jun 26, 2026

Copy link
Copy Markdown
Contributor

Summary

  • Added documentation for the new remittanceInformation field in transfer-out requests (from commit 1f9ca02)
  • Updated curl examples in transfer-out documentation to show the field
  • Updated Grid Visualizer code generator to include the field in generated API calls

Changes

Mintlify docs:

  • mintlify/snippets/sending/same-currency.mdx - Added example and Info block
  • mintlify/payouts-and-b2b/payment-flow/send-payment.mdx - Added example and Info block

Grid Visualizer:

  • components/grid-visualizer/src/lib/code-generator.ts - Added field to transfer-out body with note

Context

The remittanceInformation field (max 80 chars) allows senders to include a reference that travels with the payment to the recipient. Depending on the payment rail:

  • ACH: Populates the Addenda record
  • FedNow/RTP: Populates the remittanceInformation field
  • Wire: Populates the OBI (Originator to Beneficiary Information)

Test plan

  • make lint-openapi passes
  • Review curl examples render correctly in Mintlify

🤖 Generated with Claude Code

Add documentation for the new optional remittanceInformation field
in transfer-out requests. This field carries payment references to
recipients via ACH Addenda, FedNow/RTP remittance info, or wire OBI.

- Update same-currency transfer snippet with example
- Update send-payment guide with example and explanation
- Update Grid Visualizer code generator to include the field

Co-Authored-By: Claude Opus 4.5 <noreply@anthropic.com>
@claude claude Bot requested review from pengying and shreyav June 26, 2026 09:13
@vercel

vercel Bot commented Jun 26, 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 Jun 26, 2026 5:24pm
grid-wallet-demo Ignored Ignored Preview Jun 26, 2026 5:24pm

Request Review

@mintlify

mintlify Bot commented Jun 26, 2026

Copy link
Copy Markdown
Contributor

Preview deployment for your docs. Learn more about Mintlify Previews.

Project Status Preview Updated (UTC)
Grid 🟢 Ready View Preview Jun 26, 2026, 9:15 AM

@greptile-apps

greptile-apps Bot commented Jun 26, 2026

Copy link
Copy Markdown
Contributor

Greptile Summary

This PR adds documentation for the remittanceInformation field on transfer-out requests, covering all three payment rails (ACH, FedNow/RTP, and Wire) and updating both the full docs page and the reusable snippet.

  • Mintlify docs (send-payment.mdx and same-currency.mdx): The curl examples now include remittanceInformation: "INV-12345" and both files add an <Info> callout that correctly states the field is optional, describes the max-80-char constraint, and explains the rail-specific behavior.
  • Grid Visualizer code generator (code-generator.ts): The generated transfer-out body now includes the field with an expanded note explaining its optionality and purpose.

Confidence Score: 5/5

Pure documentation update with no runtime logic changes — safe to merge.

All three files contain only documentation content: MDX prose, a curl example, and a string note in a code generator. The Info callouts correctly and consistently describe the field as optional with the 80-char constraint and rail-specific behavior. No API contract, schema, or executable logic is changed.

No files require special attention.

Important Files Changed

Filename Overview
mintlify/payouts-and-b2b/payment-flow/send-payment.mdx Adds remittanceInformation to the same-currency curl example and a correctly-worded <Info> callout; leaves double blank line before the success JSON block (minor).
mintlify/snippets/sending/same-currency.mdx Parallel update to the snippet used by other pages; curl example and Info callout are consistent with the main send-payment page.
components/grid-visualizer/src/lib/code-generator.ts Adds remittanceInformation: 'INV-12345' to the generated transfer-out body and expands the note to communicate optionality and the 80-char limit; change is minimal and correct.

Sequence Diagram

%%{init: {'theme': 'neutral'}}%%
sequenceDiagram
    participant Client
    participant Grid API
    participant Payment Rail

    Client->>Grid API: POST /transfer-out\n{ source, destination, amount,\n  remittanceInformation: "INV-12345" }
    Grid API-->>Client: 201 Created (status: PENDING)

    Grid API->>Payment Rail: Route payment\n(ACH Addenda / FedNow-RTP remittance / Wire OBI)
    Payment Rail-->>Grid API: Settlement confirmation

    Grid API-->>Client: Webhook: OUTGOING_PAYMENT.COMPLETED
Loading
%%{init: {'theme': 'base', 'themeVariables': {"darkMode": true, "background": "#0d1117", "primaryColor": "#21262d", "primaryTextColor": "#e6edf3", "primaryBorderColor": "#8b949e", "lineColor": "#8b949e", "textColor": "#e6edf3", "edgeLabelBackground": "#161b22", "actorBkg": "#21262d", "actorBorder": "#8b949e", "actorTextColor": "#e6edf3", "actorLineColor": "#8b949e", "signalColor": "#8b949e", "signalTextColor": "#e6edf3", "noteBkgColor": "#373320", "noteBorderColor": "#d4a72c", "noteTextColor": "#f0e6c0", "labelBoxBkgColor": "#21262d", "labelBoxBorderColor": "#8b949e", "labelTextColor": "#e6edf3", "loopTextColor": "#e6edf3", "activationBkgColor": "#30363d", "activationBorderColor": "#8b949e"}}}%%
sequenceDiagram
    participant Client
    participant Grid API
    participant Payment Rail

    Client->>Grid API: POST /transfer-out\n{ source, destination, amount,\n  remittanceInformation: "INV-12345" }
    Grid API-->>Client: 201 Created (status: PENDING)

    Grid API->>Payment Rail: Route payment\n(ACH Addenda / FedNow-RTP remittance / Wire OBI)
    Payment Rail-->>Grid API: Settlement confirmation

    Grid API-->>Client: Webhook: OUTGOING_PAYMENT.COMPLETED
Loading

Reviews (2): Last reviewed commit: "docs: mark remittanceInformation as opti..." | Re-trigger Greptile

Comment thread mintlify/payouts-and-b2b/payment-flow/send-payment.mdx
Address Greptile review: the Mintlify Info callouts described remittanceInformation
but did not state it is optional (the code-generator note does), which could lead
readers to think it is required. Add the optional qualifier to both callouts.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant