Skip to content

docs: document remittanceInformation field for transfer-out #624

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
pengying merged 2 commits into from
Jul 2, 2026
Merged

docs: document remittanceInformation field for transfer-out #624

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
0466038
docs: document remittanceInformation field for transfer-out
github-actions[bot] Jun 26, 2026
7ec372d
docs: mark remittanceInformation as optional in transfer-out callouts
jacklatourette Jun 26, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
3 changes: 2 additions & 1 deletion components/grid-visualizer/src/lib/code-generator.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -196,8 +196,9 @@ export function generateSteps(
accountId: 'ExternalAccount:<external_account_id>',
},
amount: 100,
remittanceInformation: 'INV-12345',
},
note: `Amount is in the smallest unit of ${source.code} (e.g., cents for USD).`,
note: `Amount is in the smallest unit of ${source.code} (e.g., cents for USD). The remittanceInformation field (max 80 chars) is optional — it carries a reference that travels with the payment to the recipient.`,
});

return steps;
Expand Down
7 changes: 6 additions & 1 deletion mintlify/payouts-and-b2b/payment-flow/send-payment.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -77,14 +77,19 @@ curl -X POST 'https://api.lightspark.com/grid/2025-10-13/transfer-out' \
"accountId": "ExternalAccount:e85dcbd6-dced-4ec4-b756-3c3a9ea3d965",
"paymentRail": "ACH"
},
"amount": 12550
"amount": 12550,
"remittanceInformation": "INV-12345"
}'
```

<Tip>
The `paymentRail` field is optional. If omitted, Grid selects a default rail for the destination. Specify a rail (e.g., `ACH`, `WIRE`, `RTP`, `FEDNOW`) when you need to control which payment network processes the transfer.
</Tip>

<Info>
`remittanceInformation` is optional. Use it to send a reference that travels with the payment to the recipient (max 80 characters). This populates the ACH Addenda record, FedNow/RTP remittance information, or wire OBI field depending on the payment rail.
</Info>
Comment thread
greptile-apps[bot] marked this conversation as resolved.


```json Success (201 Created)
{
Expand Down
7 changes: 6 additions & 1 deletion mintlify/snippets/sending/same-currency.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -33,14 +33,19 @@ curl -X POST 'https://api.lightspark.com/grid/2025-10-13/transfer-out' \
-d '{
"source": { "accountId": "InternalAccount:a12dcbd6-dced-4ec4-b756-3c3a9ea3d123" },
"destination": { "accountId": "ExternalAccount:e85dcbd6-dced-4ec4-b756-3c3a9ea3d965", "paymentRail": "ACH" },
"amount": 12550
"amount": 12550,
"remittanceInformation": "INV-12345"
}'
```

<Tip>
The `paymentRail` field is optional. If omitted, Grid selects a default rail for the destination.
</Tip>

<Info>
`remittanceInformation` is optional. Use it to send a reference that travels with the payment to the recipient (max 80 characters). This populates the ACH Addenda record, FedNow/RTP remittance information, or wire OBI field depending on the payment rail.
</Info>

```json Success (201 Created)
{
"id": "Transaction:019542f5-b3e7-1d02-0000-000000000015",
Expand Down
Loading