OBWriteInternationalStandingOrder2

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://raw.githubusercontent.com/api-evangelist/revolut/main/json-schema/revolut-obwrite-international-standing-order2-schema.json",
  "title": "OBWriteInternationalStandingOrder2",
  "x-generated": "2026-10-12",
  "x-method": "derived",
  "x-generator": "derive-json-schema.py",
  "x-source": "openapi/revolut-international-standing-order-api-openapi.yml#/components/schemas/OBWriteInternationalStandingOrder2",
  "required": [
    "Data",
    "Risk"
  ],
  "type": "object",
  "properties": {
    "Data": {
      "$ref": "#/$defs/OBWriteDataInternationalStandingOrder2"
    },
    "Risk": {
      "$ref": "#/$defs/OBRisk1"
    }
  },
  "$defs": {
    "OBActiveCurrencyAndAmount_SimpleType": {
      "pattern": "^\\d{1,13}\\.\\d{1,5}$",
      "type": "string",
      "description": "The amount of money where the unit of currency is explicit and compliant with [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217)."
    },
    "OBBranchAndFinancialInstitutionIdentification6": {
      "type": "object",
      "properties": {
        "SchemeName": {
          "$ref": "#/$defs/OBExternalFinancialInstitutionIdentification4Code"
        },
        "Identification": {
          "maxLength": 35,
          "minLength": 1,
          "type": "string",
          "description": "The unique ID of the servicing institution."
        },
        "Name": {
          "maxLength": 140,
          "minLength": 1,
          "type": "string",
          "description": "The name of a known agent used to identify the agent."
        },
        "PostalAddress": {
          "$ref": "#/$defs/OBPostalAddress6"
        }
      },
      "description": "The party that manages the account on behalf of the account owner by:\n- Managing the registration and booking of entries on the account.\n- Calculating balances on the account.\n- Providing information about the account.\n\nThis is the servicer of the beneficiary account."
    },
    "OBCashAccountCreditor3": {
      "required": [
        "Identification",
        "Name",
        "SchemeName"
      ],
      "type": "object",
      "properties": {
        "SchemeName": {
          "$ref": "#/$defs/OBExternalAccountIdentification4Code"
        },
        "Identification": {
          "maxLength": 256,
          "minLength": 1,
          "type": "string",
          "description": "The account ID that the institution assigns to identify an account, which is known by the account owner."
        },
        "Name": {
          "maxLength": 70,
          "minLength": 1,
          "type": "string",
          "description": "The account name that the account servicing institution assigns.\n\nThe account name is the name or names of the account owner(s) represented at an account level.\n\nThe account name is not the product name or the nickname of the account.\n\n:::note\n[ASPSP](https://developer.revolut.com/docs/guides/build-banking-apps/glossary)s might optionally validate this name to confirm the payee.\n:::"
        },
        "SecondaryIdentification": {
          "maxLength": 34,
          "minLength": 1,
          "type": "string",
          "description": "The secondary account ID that the account servicing institution assigns.\n\nBuilding societies can use this ID to identify accounts with a roll number in addition to a sort code and account number combination."
        }
      },
      "description": "The details to identify the account."
    },
    "OBCashAccountDebtor4": {
      "required": [
        "Identification",
        "SchemeName"
      ],
      "type": "object",
      "description": "The details to identify the account from which the payment consent can be approved.\n\nIf provided in the consent, the [PSU](https://developer.revolut.com/docs/guides/build-banking-apps/glossary) will only be able to approve the payment consent from an account which matches the provided account identifier.\n",
      "properties": {
        "SchemeName": {
          "$ref": "#/$defs/OBExternalAccountIdentification4Code"
        },
        "Identification": {
          "maxLength": 256,
          "minLength": 1,
          "type": "string",
          "description": "The identifier assigned to the account, which is known by the account owner."
        },
        "Name": {
          "maxLength": 70,
          "minLength": 1,
          "type": "string",
          "description": "The name or names of the account owner(s) represented at an account level.\n\nThe account name is not the product name or the nickname of the account.\n\n:::warning\nThe name value is not validated against the actual owner name of the account.\n:::"
        },
        "SecondaryIdentification": {
          "maxLength": 34,
          "minLength": 1,
          "type": "string",
          "description": "The secondary account ID that the account servicing institution assigns.\n\nBuilding societies can use this ID to identify accounts with a roll number in addition to a sort code and account number combination."
        }
      }
    },
    "OBChargeBearerType1Code": {
      "type": "string",
      "description": "The party or parties bear the charges associated with the processing of the payment transaction.",
      "enum": [
        "BorneByDebtor",
        "FollowingServiceLevel"
      ]
    },
    "OBExternalAccountIdentification4Code": {
      "type": "string",
      "description": "The name of the identification scheme.",
      "enum": [
        "UK.OBIE.IBAN",
        "UK.OBIE.SortCodeAccountNumber",
        "US.RoutingNumberAccountNumber",
        "US.BranchCodeAccountNumber"
      ]
    },
    "OBExternalFinancialInstitutionIdentification4Code": {
      "type": "array",
      "items": {
        "type": "string"
      },
      "description": "The name of the identification scheme, which is published in an external list."
    },
    "OBExternalMerchantCategoryCode": {
      "type": "string",
      "description": "The merchant category code."
    },
    "OBExternalMerchantCustomerIdentification": {
      "type": "string",
      "description": "The merchant customer identification."
    },
    "OBExternalPaymentContext1Code": {
      "type": "string",
      "description": "The payment context.",
      "enum": [
        "BillPayment",
        "EcommerceGoods",
        "EcommerceServices",
        "Other",
        "PartyToParty"
      ]
    },
    "OBInternationalStandingOrder2": {
      "type": "object",
      "description": "The initiation payload that the initiating party sends to the [ASPSP](https://developer.revolut.com/docs/guides/build-banking-apps/glossary), which is used to request movement of funds from the debtor account to the creditor for an international standing order.",
      "allOf": [
        {
          "$ref": "#/$defs/OBInternationalStandingOrderBase"
        },
        {
          "type": "object",
          "properties": {
            "DebtorAccount": {
              "$ref": "#/$defs/OBCashAccountDebtor4"
            }
          }
        },
        {
          "type": "object",
          "required": [
            "CreditorAccount",
            "CurrencyOfTransfer",
            "FirstPaymentDateTime",
            "Frequency",
            "InstructedAmount"
          ]
        }
      ]
    },
    "OBInternationalStandingOrderBase": {
      "type": "object",
      "properties": {
        "Frequency": {
          "maxLength": 35,
          "minLength": 1,
          "type": "string",
          "description": "The frequency of the standing order:\n- `EvryDay`: Every day\n- `IntrvlWkDay`: Only one week interval is supported (01) and any day within the week (01 to 07)\n- `IntrvlMnthDay`: Only one month interval is supported (01) and any day within the month (1 to 31)\n\nExample values:\n- `EvryDay`\n- `IntrvlWkDay:01:0[1-7]`\n- `IntrvlMnthDay:01:(0[1-9]|[12][0-9]|3[01])`\n\n:::warning\nThe day of the interval must agree with the day from `FirstPaymentDateTime`, otherwise, for `POST` requests, the `Unsupported frequency` error is returned.\nFor example: \n- Correct: `Frequency=IntrvlMnthDay:01:03` and `FirstPaymentDateTime=2026-02-03T14:15:22Z` - the day to schedule the payment is the 3rd day of the month, and the first occurrence will be on the 3rd of February\n- Incorrect: `Frequency=IntrvlMnthDay:01:03` and `FirstPaymentDateTime=2026-02-17T14:15:22Z` - the day to schedule the payment is the 3rd day of the month, but the first occurrence is set to the 17th of February, so the days don't match.\n:::"
        },
        "Reference": {
          "maxLength": 35,
          "minLength": 1,
          "type": "string",
          "description": "The unique reference that the creditor assigns to unambiguously refer to the payment transaction.\n\nIf available, the initiating party should provide this reference in the structured remittance information to enable reconciliation by the creditor upon receipt of the amount of money.\n\nIf the business context requires the use of a creditor reference or a payment remit identification, and only one identifier can be passed through the end-to-end chain, the creditor's reference or payment remittance identification should be quoted in the end-to-end transaction identification."
        },
        "NumberOfPayments": {
          "maxLength": 35,
          "minLength": 1,
          "type": "string",
          "description": ":::warning\nCurrently, standing orders do not support ending conditions, so using this field will result in an error.\n:::\n\nThe number of payments to make, with the interval set in `frequency`, counting from the start date set in `FirstPaymentDateTime`."
        },
        "FirstPaymentDateTime": {
          "type": "string",
          "description": "The date and time when the first payment for a standing order schedule is made.\n\nAll dates in the JSON payloads are represented in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) date-time format.\nAll date-time fields in responses must include the timezone.\n\nFor example: `2017-04-05T10:43:07+00:00`.\n\n:::warning\nThe day part of the date must agree with the day of the interval set in `Frequency`, otherwise, for `POST` requests, the `Unsupported frequency` error is returned.\nFor example: \n- Correct: `Frequency=IntrvlMnthDay:01:03` and `FirstPaymentDateTime=2026-02-03T14:15:22Z` - the day to schedule the payment is the 3rd day of the month, and the first occurrence will be on the 3rd of February\n- Incorrect: `Frequency=IntrvlMnthDay:01:03` and `FirstPaymentDateTime=2026-02-17T14:15:22Z` - the day to schedule the payment is the 3rd day of the month, but the first occurrence is set to the 17th of February, so the days don't match.\n:::",
          "format": "date-time"
        },
        "FinalPaymentDateTime": {
          "type": "string",
          "description": ":::warning\nCurrently, standing orders do not support ending conditions, so this field is ignored.\n:::\n\nThe date and time when the final payment for a standing order schedule is made.\n\nAll dates in the JSON payloads are represented in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) date-time format.\nAll date-time fields in responses must include the timezone.\n\nFor example: `2017-04-05T10:43:07+00:00`.",
          "format": "date-time"
        },
        "ChargeBearer": {
          "$ref": "#/$defs/OBChargeBearerType1Code"
        },
        "CurrencyOfTransfer": {
          "pattern": "^[A-Z]{3,3}$",
          "type": "string",
          "description": "The currency of the money to be transferred, which is different from the currency of the debtor's account."
        },
        "InstructedAmount": {
          "required": [
            "Amount",
            "Currency"
          ],
          "type": "object",
          "properties": {
            "Amount": {
              "$ref": "#/$defs/OBActiveCurrencyAndAmount_SimpleType"
            },
            "Currency": {
              "pattern": "^[A-Z]{3,3}$",
              "type": "string",
              "description": "[ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) currency code in upper case."
            }
          },
          "description": "The amount of money to be moved between the debtor and creditor, before deduction of charges, expressed in the currency that the initiating party instructs.\n\nThis amount has to be transported unchanged through the transaction chain."
        },
        "Creditor": {
          "$ref": "#/$defs/OBPartyIdentification43"
        },
        "CreditorAgent": {
          "$ref": "#/$defs/OBBranchAndFinancialInstitutionIdentification6"
        },
        "CreditorAccount": {
          "$ref": "#/$defs/OBCashAccountCreditor3"
        }
      },
      "description": "The initiation payload that the initiating party sends to the [ASPSP](https://developer.revolut.com/docs/guides/build-banking-apps/glossary), which is used to request movement of funds from the debtor account to the creditor for an international standing order."
    },
    "OBPartyIdentification43": {
      "type": "object",
      "properties": {
        "Name": {
          "maxLength": 140,
          "minLength": 1,
          "type": "string",
          "description": "The name of a known party used to identify the party."
        },
        "PostalAddress": {
          "$ref": "#/$defs/OBPostalAddress6"
        }
      },
      "description": "The party that an amount of money is due to."
    },
    "OBPostalAddress6": {
      "type": "object",
      "properties": {
        "Department": {
          "maxLength": 70,
          "minLength": 1,
          "type": "string",
          "description": "The name of the department."
        },
        "SubDepartment": {
          "maxLength": 70,
          "minLength": 1,
          "type": "string",
          "description": "The name of the sub-department."
        },
        "StreetName": {
          "maxLength": 70,
          "minLength": 1,
          "type": "string",
          "description": "The name of the street."
        },
        "BuildingNumber": {
          "maxLength": 16,
          "minLength": 1,
          "type": "string",
          "description": "The number of the building."
        },
        "PostCode": {
          "maxLength": 16,
          "minLength": 1,
          "type": "string",
          "description": "The post code of the address."
        },
        "TownName": {
          "maxLength": 35,
          "minLength": 1,
          "type": "string",
          "description": "The name of the town."
        },
        "CountrySubDivision": {
          "maxLength": 35,
          "minLength": 1,
          "type": "string",
          "description": "The subdivision of the country, such as state, region, or county."
        },
        "Country": {
          "pattern": "^[A-Z]{2,2}$",
          "type": "string",
          "description": "The name of the country."
        },
        "AddressLine": {
          "maxItems": 7,
          "minItems": 0,
          "type": "array",
          "description": "The information that locates and identifies the address of the creditor, presented in free format text.",
          "items": {
            "maxLength": 70,
            "minLength": 1,
            "type": "string"
          }
        }
      },
      "description": "The postal address of the creditor, as defined by postal services."
    },
    "OBRisk1": {
      "type": "object",
      "properties": {
        "PaymentContextCode": {
          "$ref": "#/$defs/OBExternalPaymentContext1Code"
        },
        "MerchantCategoryCode": {
          "$ref": "#/$defs/OBExternalMerchantCategoryCode"
        },
        "MerchantCustomerIdentification": {
          "$ref": "#/$defs/OBExternalMerchantCustomerIdentification"
        },
        "DeliveryAddress": {
          "required": [
            "Country",
            "TownName"
          ],
          "type": "object",
          "properties": {
            "AddressLine": {
              "maxItems": 2,
              "minItems": 0,
              "type": "array",
              "description": "The information that locates and identifies the delivery address, as defined by postal services, that is presented in free format text.",
              "items": {
                "maxLength": 70,
                "minLength": 1,
                "type": "string"
              }
            },
            "StreetName": {
              "maxLength": 70,
              "minLength": 1,
              "type": "string",
              "description": "The name of the street."
            },
            "BuildingNumber": {
              "maxLength": 16,
              "minLength": 1,
              "type": "string",
              "description": "The number of the building."
            },
            "PostCode": {
              "maxLength": 16,
              "minLength": 1,
              "type": "string",
              "description": "The post code of the delivery address."
            },
            "TownName": {
              "maxLength": 35,
              "minLength": 1,
              "type": "string",
              "description": "The name of the town."
            },
            "CountrySubDivision": {
              "maxItems": 2,
              "minItems": 0,
              "type": "array",
              "description": "The subdivision of the country, for example, state, region or county.",
              "items": {
                "maxLength": 35,
                "minLength": 1,
                "type": "string"
              }
            },
            "Country": {
              "pattern": "^[A-Z]{2,2}$",
              "type": "string",
              "description": "The name of the country."
            }
          },
          "description": "The information that locates and identifies the delivery address, as defined by postal services or in free format text."
        }
      },
      "description": "The Risk section contains the risk indicators that the initiating party sends to the [ASPSP](https://developer.revolut.com/docs/guides/build-banking-apps/glossary), which can be used to specify additional details for risk scoring for account information."
    },
    "OBWriteDataInternationalStandingOrder2": {
      "required": [
        "ConsentId",
        "Initiation"
      ],
      "type": "object",
      "properties": {
        "ConsentId": {
          "maxLength": 128,
          "minLength": 1,
          "type": "string",
          "description": "The unique ID that the [ASPSP](https://developer.revolut.com/docs/guides/build-banking-apps/glossary) assigns to identify the consent resource."
        },
        "Initiation": {
          "$ref": "#/$defs/OBInternationalStandingOrder2"
        }
      }
    }
  }
}