Skip to content

docs: sync purpose of payment codes with OpenAPI schema#601

Merged
pengying merged 1 commit into
mainfrom
docs/sync-20260618
Jun 18, 2026
Merged

docs: sync purpose of payment codes with OpenAPI schema#601
pengying merged 1 commit into
mainfrom
docs/sync-20260618

Conversation

@claude

@claude claude Bot commented Jun 18, 2026

Copy link
Copy Markdown
Contributor

Summary

  • Added FAMILY_SUPPORT and SALARY_PAYMENT to the documented purpose of payment codes in the cross-currency transfers guide

These values were added to the OpenAPI schema in PR #592 (commit 460f14d) but the Mintlify documentation wasn't updated.

Changes

Documentation (mintlify/):

  • mintlify/snippets/sending/cross-currency.mdx - Added missing purpose of payment codes to match the schema

Not updated (no changes needed)

🤖 Generated with Claude Code

Syncs the documented purpose of payment codes with the OpenAPI schema
changes from commit 460f14d.

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

vercel Bot commented Jun 18, 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 Jun 18, 2026 9:38am
grid-wallet-demo Ignored Ignored Jun 18, 2026 9:38am

Request Review

@greptile-apps

greptile-apps Bot commented Jun 18, 2026

Copy link
Copy Markdown
Contributor

Greptile Summary

This PR syncs the cross-currency transfers guide with the OpenAPI schema by adding FAMILY_SUPPORT and SALARY_PAYMENT to the documented purpose-of-payment codes.

  • Both values are present in openapi/components/schemas/quotes/PurposeOfPayment.yaml (and the bundled mintlify/openapi.yaml) and are inserted in the correct position before OTHER, matching the schema order exactly.
  • No other documentation files reference the full purpose-of-payment enum, so the single-file change is complete and sufficient.

Confidence Score: 5/5

Documentation-only change that adds two enum values already present in the OpenAPI schema — safe to merge.

The change is a two-line addition to a Markdown accordion, verified against the canonical schema source. No code is altered, no logic is affected, and no other documentation files enumerate the purpose-of-payment codes, so nothing else needs updating.

No files require special attention.

Important Files Changed

Filename Overview
mintlify/snippets/sending/cross-currency.mdx Added FAMILY_SUPPORT and SALARY_PAYMENT to the purpose-of-payment accordion; values and ordering match the OpenAPI schema exactly.

Flowchart

%%{init: {'theme': 'neutral'}}%%
flowchart TD
    A[POST /quotes] --> B{purposeOfPayment\nrequired for corridor?}
    B -- No --> C[Create quote without code]
    B -- Yes --> D[Choose purpose code]
    D --> E[GIFT / SELF / GOODS_OR_SERVICES\nEDUCATION / HEALTH_OR_MEDICAL\nREAL_ESTATE_PURCHASE / TAX_PAYMENT\nLOAN_PAYMENT / UTILITY_BILL\nDONATION / TRAVEL]
    D --> F["FAMILY_SUPPORT new\nSALARY_PAYMENT new"]
    D --> G[OTHER]
    E --> H[Quote created with locked exchange rate]
    F --> H
    G --> H
    C --> H
    H --> I[Execute quote → Transfer]
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"}}}%%
flowchart TD
    A[POST /quotes] --> B{purposeOfPayment\nrequired for corridor?}
    B -- No --> C[Create quote without code]
    B -- Yes --> D[Choose purpose code]
    D --> E[GIFT / SELF / GOODS_OR_SERVICES\nEDUCATION / HEALTH_OR_MEDICAL\nREAL_ESTATE_PURCHASE / TAX_PAYMENT\nLOAN_PAYMENT / UTILITY_BILL\nDONATION / TRAVEL]
    D --> F["FAMILY_SUPPORT new\nSALARY_PAYMENT new"]
    D --> G[OTHER]
    E --> H[Quote created with locked exchange rate]
    F --> H
    G --> H
    C --> H
    H --> I[Execute quote → Transfer]
Loading

Reviews (1): Last reviewed commit: "docs: add FAMILY_SUPPORT and SALARY_PAYM..." | Re-trigger Greptile

@mintlify

mintlify Bot commented Jun 18, 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 18, 2026, 10:33 AM

@pengying pengying merged commit 318fc5a into main Jun 18, 2026
9 checks passed
@pengying pengying deleted the docs/sync-20260618 branch June 18, 2026 23:51
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