Atlar · Schema
ExternalAccountJSONPatchRequest
JSON Patch request to update an external account.
CompanyFintechTreasuryPaymentsBankingCash ManagementFinancial OperationsERP Integration
JSON Schema
{
"$schema": "https://json-schema.org/draft/2020-12/schema",
"$id": "https://artifacts.apis.io/atlar/json-schema/atlar-external-account-jsonpatch-request-schema.json",
"title": "ExternalAccountJSONPatchRequest",
"description": "JSON Patch request to update an external account.",
"x-generated": "2026-11-10",
"x-method": "derived",
"x-generator": "derive-json-schema.py",
"x-source": "openapi/atlar-external-accounts-api-openapi.yml#/components/schemas/ExternalAccountJSONPatchRequest",
"type": "array",
"items": {
"oneOf": [
{
"$ref": "#/$defs/ExternalAccountJSONPatchRemoveAlias"
},
{
"$ref": "#/$defs/ExternalAccountJSONPatchReplaceAlias"
},
{
"$ref": "#/$defs/ExternalAccountJSONPatchAddIdentifiers"
},
{
"$ref": "#/$defs/ExternalAccountJSONPatchAddRouting"
}
]
},
"$defs": {
"AccountIdentifier": {
"type": "object",
"properties": {
"type": {
"$ref": "#/$defs/AccountIdentifierType"
},
"market": {
"$ref": "#/$defs/MarketCode",
"description": "The market of the `AccountIdentifier` specifies in which market-context the identifier should be treated.\n\nA `NUMBER` from Sweden does not look and does not validate in the same way as a `NUMBER` from GB. The market\ncode is, in most cases, the same as where the account itself is domiciled, but not necessarily. An examples\nof this discrepancy is Jersey which may have domiciled accounts with market `JE`, but the account identifier\nwould be an `IBAN` with country code `GB`."
},
"number": {
"type": "string",
"description": "The unformatted identifier itself. For type `NUMBER` the structure of the account number is country-specific.",
"minLength": 1,
"maxLength": 255
},
"invalid": {
"type": "boolean",
"description": "Will be `true` if the account identifier is invalid according to Atlar account identifier validation rules.",
"readOnly": true
}
},
"required": [
"type",
"market",
"number"
]
},
"AccountIdentifierType": {
"type": "string",
"enum": [
"IBAN",
"NUMBER",
"ADYEN",
"AU_BPAY_BILLER_CODE",
"DK_FIK",
"INVESTMENT_NUMBER",
"NATIONAL_ID_NUMBER",
"PAYPAL",
"PROPRIETARY",
"SE_BANKGIRO",
"SE_PLUSGIRO",
"SOLDO",
"WALLET_ADYEN_BALANCE_PLATFORM",
"WALLET_AIRWALLEX",
"WALLET_AIRWALLEX_NUMBER",
"WALLET_CURRENCYCLOUD",
"WALLET_FLASH_PAYMENTS",
"WALLET_FREEMARKET",
"WALLET_HYPERWALLET",
"WALLET_INPAY",
"WALLET_LEAD",
"WALLET_MERCURY",
"WALLET_MONEYCORP",
"WALLET_PAYHAWK",
"WALLET_REVOLUT",
"WALLET_SKRILL",
"WALLET_STRIPE",
"WALLET_SWISSQUOTE",
"WALLET_UNIT"
],
"description": "Account Identifier type. Choose among:\n<ul>\n<li><code>IBAN</code> — IBAN</li>\n<li><code>NUMBER</code> — Account number</li>\n<li><code>ADYEN</code> — Adyen identifier</li>\n<li><code>AU_BPAY_BILLER_CODE</code> — Australian BPAY Biller Code</li>\n<li><code>DK_FIK</code> — FIK creditor number</li>\n<li><code>INVESTMENT_NUMBER</code> — Investment number</li>\n<li><code>NATIONAL_ID_NUMBER</code> — National Identification Number</li>\n<li><code>PAYPAL</code> — PayPal wallet identifier</li>\n<li><code>PROPRIETARY</code> — Proprietary identifier</li>\n<li><code>SE_BANKGIRO</code> — <a href=\"https://www.bankgirot.se/en/\">Bankgiro number</a></li>\n<li><code>SE_PLUSGIRO</code> — <a href=\"https://www.nordea.se/foretag/produkter/betala/plusgirot.html\">Plusgiro number</a></li>\n<li><code>SOLDO</code> — Soldo entity identifier</li>\n<li><code>WALLET_ADYEN_BALANCE_PLATFORM</code> — Adyen balance platform wallet identifier</li>\n<li><code>WALLET_AIRWALLEX</code> — Airwallex wallet identifier</li>\n<li><code>WALLET_AIRWALLEX_NUMBER</code> — Airwallex account number</li>\n<li><code>WALLET_CURRENCYCLOUD</code> — Currencycloud wallet identifier</li>\n<li><code>WALLET_FLASH_PAYMENTS</code> — Flash Payments wallet identifier</li>\n<li><code>WALLET_FREEMARKET</code> — Freemarket wallet identifier</li>\n<li><code>WALLET_HYPERWALLET</code> — Hyperwallet wallet identifier</li>\n<li><code>WALLET_INPAY</code> — Inpay account identifier</li>\n<li><code>WALLET_LEAD</code> — Lead wallet identifier</li>\n<li><code>WALLET_MERCURY</code> — Mercury wallet identifier</li>\n<li><code>WALLET_MONEYCORP</code> — Moneycorp wallet identifier</li>\n<li><code>WALLET_PAYHAWK</code> — Payhawk wallet identifier</li>\n<li><code>WALLET_REVOLUT</code> — Revolut wallet identifier</li>\n<li><code>WALLET_SKRILL</code> — Skrill wallet identifier</li>\n<li><code>WALLET_STRIPE</code> — Stripe wallet identifier</li>\n<li><code>WALLET_SWISSQUOTE</code> — Swissquote wallet identifier</li>\n<li><code>WALLET_UNIT</code> — Unit wallet identifier</li>\n</ul>\nFor further information please refer to <a href=\"https://docs.atlar.com/v2.0/docs/payment-details#account-identifiers\">Account Identifiers</a>"
},
"ExternalAccountJSONPatchAddIdentifiers": {
"description": "Adds an account identifier.",
"type": "object",
"properties": {
"op": {
"type": "string",
"enum": [
"add"
]
},
"path": {
"type": "string",
"enum": [
"/identifiers/-"
]
},
"value": {
"$ref": "#/$defs/AccountIdentifier"
}
},
"additionalProperties": false,
"required": [
"op",
"path",
"value"
]
},
"ExternalAccountJSONPatchAddRouting": {
"description": "Adds a routing identifier.",
"type": "object",
"properties": {
"op": {
"type": "string",
"enum": [
"add"
]
},
"path": {
"type": "string",
"enum": [
"/routing/-"
]
},
"value": {
"$ref": "#/$defs/RoutingIdentifier"
}
},
"additionalProperties": false,
"required": [
"op",
"path",
"value"
]
},
"ExternalAccountJSONPatchRemoveAlias": {
"description": "Remove alias.",
"type": "object",
"properties": {
"op": {
"type": "string",
"enum": [
"remove"
]
},
"path": {
"type": "string",
"enum": [
"/alias"
]
}
},
"additionalProperties": false,
"required": [
"op",
"path"
]
},
"ExternalAccountJSONPatchReplaceAlias": {
"description": "Set alias.",
"type": "object",
"properties": {
"op": {
"type": "string",
"enum": [
"replace"
]
},
"path": {
"type": "string",
"enum": [
"/alias"
]
},
"value": {
"type": "string",
"minLength": 1,
"maxLength": 255
}
},
"additionalProperties": false,
"required": [
"op",
"path",
"value"
]
},
"MarketCode": {
"type": "string",
"description": "Two-letter ISO 3166-1 alpha2 country code.",
"minLength": 2,
"maxLength": 2,
"pattern": "^[A-Z]{2,2}$"
},
"RoutingConstraints": {
"description": "Constraints on a `RoutingIdentifier`.",
"type": "object",
"properties": {
"accountNumberType": {
"$ref": "#/$defs/AccountIdentifierType",
"x-go-type-skip-optional-pointer": true
},
"scheme": {
"type": "string"
}
}
},
"RoutingIdentifier": {
"type": "object",
"properties": {
"type": {
"$ref": "#/$defs/RoutingIdentifierType"
},
"number": {
"type": "string",
"description": "The form of the routing number depends on `type`. E.g. for `BIC` the value should be an 8 or 11 character BIC/SWIFT code. For `GB_DSC` (UK domestic routing) the value should be a six digit sort code.",
"minLength": 1,
"maxLength": 255
},
"invalid": {
"type": "boolean",
"description": "Will be `true` if the routing identifier is invalid according to Atlar validation rules.",
"readOnly": true
},
"constraints": {
"$ref": "#/$defs/RoutingConstraints"
}
},
"required": [
"type",
"number"
]
},
"RoutingIdentifierType": {
"type": "string",
"enum": [
"BIC",
"AT_BLZ",
"AU_BSB",
"BD_BRN",
"BR_BRANCH",
"BR_COMPE",
"BR_ISP",
"CA_CPA",
"CH_BCC",
"CH_SIC",
"CL_SBIF",
"CN_APS",
"CZ_NBC",
"DE_BLZ",
"ES_NCC",
"GB_DSC",
"GR_BIC",
"HK_NCC",
"IE_NCC",
"IL_NCC",
"IN_FSC",
"IT_NCC",
"JP_ZGN",
"KR_BOK",
"KR_KFTC",
"MX_ABM",
"MY_NCC",
"NZ_NCC",
"PH_BRSTN",
"PL_KNR",
"PT_NCC",
"RU_CBC",
"SE_SBA",
"SG_IBG",
"TH_CBC",
"TW_NCC",
"US_ABA",
"US_PID",
"VN_CITAD",
"ZA_NCC"
],
"description": "A routing identifier of type `BIC` must be provided to support cross-border/SWIFT payments."
}
}
}
Work with this as data
Every JSON Schema here is available over the APIs.io API and to AI agents over MCP.
MCP server
One button, every client — Claude, Cursor, VS Code and the rest.
https://apis.io/mcp
Tools for schemas
4 MCP tools reach this
find_json_schemasBrowse and filter every JSON Schema in the catalog.apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.resolveTurn a domain, URL or GitHub org into the provider it belongs to.find_cohortsEvery scored population of providers in the catalog.
Call it yourself
curl for this page
This JSON Schema
curl "https://apis.io/api/v1/json-schemas/atlar-external-account-jsonpatch-request"
All schemas
curl "https://apis.io/api/v1/json-schemas?limit=25"
Calls without X-API-Key need no key. Calls with it need a paid plan — get a key.
Get an API key
Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.
A second provider on the same verified email joins the account you already have.