Weavr · Schema

OutgoingWireTransferCreateRequest

Embedded FinanceBanking as a ServicePaymentsCardsFintechAccountKYCCompany

Properties

Name	Type	Description
profileId	object
tag	object
sourceInstrument	object	The managed account from which funds will be collected.
transferAmount	object	The amount, in same currency as source and destination, that was transferred from the source.
purpose	string	The purpose of the payment. Mandatory for wire transfers executed over `SWIFT`.
description	string	These details are passed to the beneficiary as the `reference` . This field is mandatory for wire transfers executed over `SEPA`and `SWIFT`. The allowed length is dependent on the payment type: `SEPA`
destinationBeneficiary	object
scheduledTimestamp	object

View JSON Schema on GitHub

JSON Schema

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://raw.githubusercontent.com/api-evangelist/weavr/main/json-schema/weavr-outgoing-wire-transfer-create-request-schema.json",
  "title": "OutgoingWireTransferCreateRequest",
  "x-generated": "2026-10-12",
  "x-method": "derived",
  "x-generator": "derive-json-schema.py",
  "x-source": "openapi/weavr-operations-api-openapi.yml#/components/schemas/OutgoingWireTransferCreateRequest",
  "required": [
    "destinationBeneficiary",
    "profileId",
    "sourceInstrument",
    "transferAmount"
  ],
  "type": "object",
  "properties": {
    "profileId": {
      "$ref": "#/$defs/ProfileId"
    },
    "tag": {
      "$ref": "#/$defs/Tag"
    },
    "sourceInstrument": {
      "description": "The managed account from which funds will be collected.",
      "required": [
        "type",
        "id"
      ],
      "type": "object",
      "properties": {
        "type": {
          "type": "string",
          "enum": [
            "managed_accounts"
          ]
        },
        "id": {
          "type": "string",
          "pattern": "^[0-9]+$"
        }
      }
    },
    "transferAmount": {
      "description": "The amount, in same currency as source and destination, that was transferred from the source.",
      "$ref": "#/$defs/CurrencyAmount"
    },
    "purpose": {
      "type": "string",
      "maxLength": 255,
      "description": "The purpose of the payment. Mandatory for wire transfers executed over `SWIFT`."
    },
    "description": {
      "type": "string",
      "description": "These details are passed to the beneficiary as the `reference` . This field is mandatory for wire transfers executed over `SEPA`and `SWIFT`. The allowed length is dependent on the payment type:\n\n`SEPA` <= `35` characters. An extended character set is accepted to cater for all European languages. If `SEPA` does not support a particular character, it is automatically converted to an acceptable alternative, in line with `SEPA` scheme guidance.\n\n`SWIFT` <= `35` characters\n\n`Faster Payments` <= `18` characters\n"
    },
    "destinationBeneficiary": {
      "oneOf": [
        {
          "$ref": "#/$defs/OutgoingWireTransferBeneficiary"
        },
        {
          "$ref": "#/$defs/SEPABeneficiary"
        },
        {
          "$ref": "#/$defs/SWIFTBeneficiary"
        },
        {
          "$ref": "#/$defs/RIXBeneficiary"
        },
        {
          "$ref": "#/$defs/FasterPaymentsBeneficiary"
        },
        {
          "$ref": "#/$defs/BeneficiaryId"
        },
        {
          "$ref": "#/$defs/ExternalAccountId"
        }
      ]
    },
    "scheduledTimestamp": {
      "$ref": "#/$defs/ScheduledTimestamp"
    }
  },
  "$defs": {
    "BeneficiaryId": {
      "required": [
        "beneficiaryId"
      ],
      "type": "object",
      "properties": {
        "beneficiaryId": {
          "$ref": "#/$defs/Id"
        }
      }
    },
    "Currency": {
      "type": "string",
      "description": "The currency expressed in ISO-4217 code. Example: GBP, EUR, USD.",
      "maxLength": 3,
      "minLength": 3,
      "pattern": "^[A-Z]*$"
    },
    "CurrencyAmount": {
      "required": [
        "currency",
        "amount"
      ],
      "type": "object",
      "properties": {
        "currency": {
          "$ref": "#/$defs/Currency"
        },
        "amount": {
          "type": "integer",
          "format": "int64",
          "description": "The monetary amount, scaled to the lowest denomination of the currency.\n\nExample, an amount of 1000 for a EUR currency is actually 1000 Euro cents or EUR 10.00.\n"
        }
      },
      "description": "The object representing a monetary amount in a particular currency."
    },
    "DateOfBirth": {
      "type": "string",
      "format": "date",
      "description": "The date of birth in ISO 8601 format (YYYY-MM-DD)."
    },
    "ExternalAccountId": {
      "type": "object",
      "description": "The id of an external account, such as a Linked Account, registered with the Weavr Platform.",
      "required": [
        "type",
        "id"
      ],
      "properties": {
        "type": {
          "$ref": "#/$defs/ExternalAccountType"
        },
        "id": {
          "type": "string",
          "pattern": "^[0-9]+$"
        }
      }
    },
    "ExternalAccountType": {
      "type": "string",
      "enum": [
        "linked_accounts"
      ]
    },
    "FasterPaymentsBankDetailsOrBACSBankDetails": {
      "required": [
        "accountNumber",
        "sortCode"
      ],
      "type": "object",
      "description": "Bank details used in case the wire transfer is executed over Faster Payments.",
      "properties": {
        "accountNumber": {
          "type": "string",
          "pattern": "^[0-9]{8}$",
          "description": "Account number, required for wire transfer over Faster Payments."
        },
        "sortCode": {
          "type": "string",
          "pattern": "^[0-9]{6}$",
          "description": "Sort code, required for wire transfer over Faster Payments."
        },
        "secondaryReference": {
          "type": "string"
        }
      }
    },
    "FasterPaymentsBeneficiary": {
      "required": [
        "name",
        "type",
        "accountNumber",
        "sortCode"
      ],
      "type": "object",
      "description": "Beneficiary details for Faster Payments wire transfers.",
      "properties": {
        "name": {
          "type": "string",
          "minLength": 1,
          "maxLength": 140,
          "pattern": "^[a-zA-Z0-9\\/\\-?:().,'+\\s#=!\"%&*<>;\\{@\\r\\n]*$",
          "description": "The beneficiary's full name. >= 1 character and <= 140 characters.\nNote: the ' symbol is the unicode value U+2019 (right single quotation mark)\nand not the unicode value U+0027 (apostrophe).\n"
        },
        "type": {
          "type": "string",
          "description": "The type of beneficiary account. Required for Faster Payments.",
          "enum": [
            "PERSONAL",
            "BUSINESS"
          ]
        },
        "accountNumber": {
          "type": "string",
          "pattern": "^[0-9]{8}$",
          "description": "Account number, required for wire transfer over Faster Payments."
        },
        "sortCode": {
          "type": "string",
          "pattern": "^[0-9]{6}$",
          "description": "Sort code, required for wire transfer over Faster Payments."
        },
        "secondaryReference": {
          "type": "string",
          "description": "Optional secondary reference for accounts without unique sort codes."
        },
        "address": {
          "maxLength": 150,
          "minLength": 1,
          "type": "string",
          "description": "The beneficiary's address."
        },
        "bankName": {
          "type": "string",
          "description": "The beneficiary's bank name."
        },
        "bankAddress": {
          "maxLength": 150,
          "minLength": 1,
          "type": "string",
          "description": "The beneficiary's bank address."
        },
        "bankCountry": {
          "type": "string",
          "description": "The beneficiary's bank country in ISO 3166 alpha-2 format.",
          "maxLength": 2,
          "minLength": 2,
          "pattern": "^[A-Z]{2}$"
        },
        "nationality": {
          "$ref": "#/$defs/Nationality"
        },
        "dateOfBirth": {
          "$ref": "#/$defs/DateOfBirth"
        }
      }
    },
    "IBANDetails": {
      "required": [
        "iban"
      ],
      "type": "object",
      "description": "Bank details used in case the wire transfer is executed over SEPA or RIX",
      "properties": {
        "iban": {
          "type": "string",
          "minLength": 15,
          "maxLength": 34,
          "pattern": "^[A-Z]{2}[0-9]{2}[A-Z0-9]{11,30}$",
          "description": "International Bank Account Number, required for wire transfer over SEPA or RIX"
        },
        "bankIdentifierCode": {
          "type": "string",
          "minLength": 8,
          "maxLength": 11,
          "pattern": "^[a-zA-Z0-9]{4}[a-zA-Z]{2}[a-zA-Z0-9]{2}[a-zA-Z0-9]{0,3}$",
          "description": "BIC, for wire transfer over SEPA or RIX"
        }
      }
    },
    "Id": {
      "type": "string",
      "pattern": "^[0-9]+$"
    },
    "Nationality": {
      "maxLength": 2,
      "minLength": 2,
      "pattern": "^[A-Z]+$",
      "type": "string",
      "description": "Nationality of the user - using ISO 3166 alpha-2."
    },
    "OutgoingWireTransferBeneficiary": {
      "deprecated": true,
      "required": [
        "name",
        "bankAccountDetails"
      ],
      "type": "object",
      "description": "Details of the beneficiary of the outgoing wire transfer.\n**Deprecated**: Use `SEPABeneficiary` for SEPA/IBAN transfers or `FasterPaymentsBeneficiary` for Faster Payments transfers instead.\n",
      "properties": {
        "name": {
          "type": "string",
          "description": "The beneficiary's full name. The allowed length and pattern is dependent on the bank account details type:\n\n`IBANDetails`: >= `1` character and <= `150` characters. An extended character set is accepted to cater for all European languages. If `SEPA` does not support a particular character, it is automatically converted to an acceptable alternative, in line with `SEPA` scheme guidance.\n\n`FasterPaymentsBankDetailsOrBACSBankDetails`: >= `1` character and <= `140` characters with a pattern of `^[a-zA-Z0-9\\/\\-?:().,’+\\s#=!\"%&*<>;\\{@\\r\\n]*$`\n(please note that the `’` symbol is the unicode value U+2019 (right single quotation mark) and not the unicode value U+0027 (apostrophe))\n"
        },
        "type": {
          "type": "string",
          "description": "The type of beneficiary account. Required only when `FasterPaymentsBankDetailsOrBACSBankDetails` are specified",
          "enum": [
            "PERSONAL",
            "BUSINESS"
          ]
        },
        "address": {
          "maxLength": 150,
          "minLength": 1,
          "type": "string",
          "description": "The beneficiary’s address. For `SEPA`, an extended character set is accepted to cater for all European languages. If `SEPA` does not support a particular character, it is automatically converted to an acceptable alternative, in line with `SEPA` scheme guidance.\n"
        },
        "bankName": {
          "type": "string",
          "description": "The beneficiary's bank name."
        },
        "bankAddress": {
          "maxLength": 150,
          "minLength": 1,
          "type": "string",
          "description": "The beneficiary's bank address."
        },
        "bankCountry": {
          "type": "string",
          "description": "The beneficiary's bank country in ISO 3166 alpha-2 format.",
          "maxLength": 2,
          "minLength": 2,
          "pattern": "^[A-Z]{2}$"
        },
        "bankAccountDetails": {
          "description": "Details of the beneficiary bank account, depending on the type of transfer chosen.",
          "oneOf": [
            {
              "$ref": "#/$defs/IBANDetails"
            },
            {
              "$ref": "#/$defs/FasterPaymentsBankDetailsOrBACSBankDetails"
            }
          ]
        },
        "nationality": {
          "$ref": "#/$defs/Nationality"
        },
        "dateOfBirth": {
          "$ref": "#/$defs/DateOfBirth"
        }
      }
    },
    "ProfileId": {
      "type": "string",
      "description": "The profile Id which a specific identity, instrument or transaction type is linked to.\n\nProfiles contain configuration and determine behavioral aspects of the newly created transaction, for example, fees that may apply.\n\nYou can have one or more profiles linked to your application, and these can be used to drive different behaviors according to your product's needs.\n\nProfile Ids can be found in the Multi Portal, in the API Credentials page.\n",
      "pattern": "^[0-9]+$"
    },
    "RIXBeneficiary": {
      "required": [
        "name",
        "iban"
      ],
      "type": "object",
      "description": "Beneficiary details for RIX wire transfers.",
      "properties": {
        "name": {
          "type": "string",
          "minLength": 1,
          "maxLength": 150,
          "description": "The beneficiary's full name. >= 1 character and <= 150 characters.\nAn extended character set is accepted to cater for all European languages.\nIf RIX does not support a particular character, it is automatically\nconverted to an acceptable alternative.\n"
        },
        "iban": {
          "type": "string",
          "minLength": 15,
          "maxLength": 34,
          "pattern": "^[A-Z]{2}[0-9]{2}[A-Z0-9]{11,30}$",
          "description": "International Bank Account Number, required for wire transfer over RIX."
        },
        "bankIdentifierCode": {
          "type": "string",
          "minLength": 8,
          "maxLength": 11,
          "pattern": "^[a-zA-Z0-9]{4}[a-zA-Z]{2}[a-zA-Z0-9]{2}[a-zA-Z0-9]{0,3}$",
          "description": "BIC (Bank Identifier Code) for wire transfer over RIX."
        },
        "address": {
          "maxLength": 150,
          "minLength": 1,
          "type": "string",
          "description": "The beneficiary's address. An extended character set is accepted to cater\nfor all European languages. If RIX does not support a particular character,\nit is automatically converted to an acceptable alternative.\n"
        },
        "bankName": {
          "type": "string",
          "description": "The beneficiary's bank name."
        },
        "bankAddress": {
          "maxLength": 150,
          "minLength": 1,
          "type": "string",
          "description": "The beneficiary's bank address."
        },
        "bankCountry": {
          "type": "string",
          "description": "The beneficiary's bank country in ISO 3166 alpha-2 format.",
          "maxLength": 2,
          "minLength": 2,
          "pattern": "^[A-Z]{2}$"
        },
        "nationality": {
          "$ref": "#/$defs/Nationality"
        },
        "dateOfBirth": {
          "$ref": "#/$defs/DateOfBirth"
        }
      }
    },
    "SEPABeneficiary": {
      "required": [
        "name",
        "iban"
      ],
      "type": "object",
      "description": "Beneficiary details for SEPA/IBAN wire transfers.",
      "properties": {
        "name": {
          "type": "string",
          "minLength": 1,
          "maxLength": 150,
          "description": "The beneficiary's full name. >= 1 character and <= 150 characters.\nAn extended character set is accepted to cater for all European languages.\nIf SEPA does not support a particular character, it is automatically\nconverted to an acceptable alternative, in line with SEPA scheme guidance.\n"
        },
        "iban": {
          "type": "string",
          "minLength": 15,
          "maxLength": 34,
          "pattern": "^[A-Z]{2}[0-9]{2}[A-Z0-9]{11,30}$",
          "description": "International Bank Account Number, required for wire transfer over SEPA."
        },
        "bankIdentifierCode": {
          "type": "string",
          "minLength": 8,
          "maxLength": 11,
          "pattern": "^[a-zA-Z0-9]{4}[a-zA-Z]{2}[a-zA-Z0-9]{2}[a-zA-Z0-9]{0,3}$",
          "description": "BIC (Bank Identifier Code) for wire transfer over SEPA."
        },
        "address": {
          "maxLength": 150,
          "minLength": 1,
          "type": "string",
          "description": "The beneficiary's address. An extended character set is accepted to cater\nfor all European languages. If SEPA does not support a particular character,\nit is automatically converted to an acceptable alternative.\n"
        },
        "bankName": {
          "type": "string",
          "description": "The beneficiary's bank name."
        },
        "bankAddress": {
          "maxLength": 150,
          "minLength": 1,
          "type": "string",
          "description": "The beneficiary's bank address."
        },
        "bankCountry": {
          "type": "string",
          "description": "The beneficiary's bank country in ISO 3166 alpha-2 format.",
          "maxLength": 2,
          "minLength": 2,
          "pattern": "^[A-Z]{2}$"
        },
        "nationality": {
          "$ref": "#/$defs/Nationality"
        },
        "dateOfBirth": {
          "$ref": "#/$defs/DateOfBirth"
        }
      }
    },
    "SWIFTBeneficiary": {
      "required": [
        "name",
        "account",
        "address",
        "bankCountry"
      ],
      "type": "object",
      "description": "Beneficiary details for SWIFT wire transfers.",
      "properties": {
        "name": {
          "type": "string",
          "minLength": 1,
          "maxLength": 150,
          "description": "The beneficiary's full name."
        },
        "account": {
          "type": "string",
          "minLength": 1,
          "maxLength": 34,
          "pattern": "^[a-zA-Z0-9]{1,34}$",
          "description": "Can be either an account number or an International Bank Account Number (IBAN)."
        },
        "bankIdentifierCode": {
          "type": "string",
          "minLength": 8,
          "maxLength": 11,
          "pattern": "^[a-zA-Z0-9]{8,11}$",
          "description": "Required if account is not an IBAN. Bank Identifier Code (BIC)."
        },
        "address": {
          "maxLength": 150,
          "minLength": 1,
          "type": "string",
          "description": "The beneficiary's address."
        },
        "bankName": {
          "type": "string",
          "description": "The beneficiary's bank name."
        },
        "bankAddress": {
          "maxLength": 150,
          "minLength": 1,
          "type": "string",
          "description": "The beneficiary's bank address."
        },
        "bankCountry": {
          "type": "string",
          "description": "The beneficiary's bank country in ISO 3166 alpha-2 format.",
          "maxLength": 2,
          "minLength": 2,
          "pattern": "^[A-Z]{2}$"
        },
        "nationality": {
          "$ref": "#/$defs/Nationality"
        },
        "dateOfBirth": {
          "$ref": "#/$defs/DateOfBirth"
        }
      }
    },
    "ScheduledTimestamp": {
      "pattern": "^[0-9]+$",
      "type": "string",
      "description": "The epoch timestamp at which the transaction is scheduled to be executed."
    },
    "Tag": {
      "type": "string",
      "description": "The tag field is a custom field that can be used to search and filter.",
      "maxLength": 50,
      "pattern": "^[a-zA-Z0-9_-]+$"
    }
  }
}

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.

All 92 tools →

Call it yourself

curl for this page

This JSON Schema

curl "https://apis.io/api/v1/json-schemas/weavr-outgoing-wire-transfer-create-request"

All schemas

curl "https://apis.io/api/v1/json-schemas?limit=25"

Discovery needs no key. Ratings and market analysis are Pro.

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.

GitHub Google LinkedIn

A second provider on the same verified email joins the account you already have.