docs(api): align TaxId schemas across fx-account and fx-payment with dev-utils 2.79.0#14
Closed
diegopereira90 wants to merge 3 commits intomainfrom
Closed
docs(api): align TaxId schemas across fx-account and fx-payment with dev-utils 2.79.0#14diegopereira90 wants to merge 3 commits intomainfrom
diegopereira90 wants to merge 3 commits intomainfrom
Conversation
fx-account: drop redundant `country` field and rename `value` → `number`
on TaxIdRequest/TaxIdResponse to match the shared TaxId domain type.
Update 3 invalidTaxId error examples and 4 inline body examples to the
new shape. Add a markdown country-mapping table to TaxIdType so
consumers can discover the right type for their jurisdiction without
the redundant field.
fx-payment: factor out TaxIdType as a proper enum schema (all 59 values)
with the same markdown country table, replacing the previous untyped
`type: string`. Existing inline body examples already use {type, number}
so no example changes were needed.
Companion to fx-account PR #122.
Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
|
Preview deployment for your docs. Learn more about Mintlify Previews.
💡 Tip: Enable Workflows to automatically generate PRs for you. |
Two journey docs still showed stale taxId shapes that the openapi.yml
update (previous commit) made inconsistent with the spec:
- open-multi-currency-account.mdx: two curl bodies used the old
{value, type, country} shape from fx-account. Updated to {type, number}.
- withdrawal.mdx: the fx-payment beneficiary example sent taxId as a
bare string ("12345678901"); the fx-payment spec defines TaxId as an
object {type, number}. Pre-existing inconsistency, fixed for clarity.
Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
Aligns fx-account and fx-payment OpenAPI specs with development-utils 2.79.0, which renamed `TaxId.number` → `TaxId.value`. Updates: - TaxIdRequest / TaxIdResponse schema (fx-account) - TaxId schema (fx-payment) - All inline JSON/YAML examples in path operations - Error response field paths (e.g., `body:owner.taxId.number` → `body:owner.taxId.value`) - Journey examples (open-multi-currency-account, withdrawal) The `number` name implied a numeric format, but several types are alphanumeric (ABN, VAT_GB, RFC, USCC, GSTIN, NIF_ES, NIE, etc.). Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
diegopereira90
changed the title
Contributor
Author
|
Superseded by Mário's #15 ( |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
TaxId.number→TaxId.value)TaxIdRequest/TaxIdResponse(fx-account) andTaxId(fx-payment) schemasbody:owner.taxId.number→body:owner.taxId.value,body:taxId.number→body:taxId.value)open-multi-currency-account.mdx,withdrawal.mdx)Why
The previous
numbername implied a numeric format, but several real-world tax IDs are alphanumeric (ABN, VAT_GB, RFC, USCC, GSTIN, NIF_ES, NIE, PARTITA_IVA, CODICE_FISCALE, etc.). Thevaluename is honest about the contract being a string identifier.Test plan
🤖 Generated with Claude Code