OBWriteInternationalScheduledConsentResponse2

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://raw.githubusercontent.com/api-evangelist/revolut/main/json-schema/revolut-obwrite-international-scheduled-consent-response2-schema.json",
  "title": "OBWriteInternationalScheduledConsentResponse2",
  "x-generated": "2026-10-12",
  "x-method": "derived",
  "x-generator": "derive-json-schema.py",
  "x-source": "openapi/revolut-international-scheduled-payment-api-openapi.yml#/components/schemas/OBWriteInternationalScheduledConsentResponse2",
  "required": [
    "Data",
    "Links",
    "Meta",
    "Risk"
  ],
  "type": "object",
  "properties": {
    "Data": {
      "$ref": "#/$defs/OBWriteDataInternationalScheduledConsentResponse2"
    },
    "Risk": {
      "$ref": "#/$defs/OBRisk1"
    },
    "Links": {
      "$ref": "#/$defs/Links"
    },
    "Meta": {
      "$ref": "#/$defs/Meta"
    }
  },
  "$defs": {
    "Links": {
      "required": [
        "Self"
      ],
      "type": "object",
      "properties": {
        "Self": {
          "type": "string",
          "description": "The absolute URI to the resource.",
          "format": "uri"
        },
        "Next": {
          "type": "string",
          "description": "The absolute URI to the next pagination resource.",
          "format": "uri"
        },
        "Prev": {
          "type": "string",
          "description": "The absolute URI to the previous pagination resource.",
          "format": "uri"
        }
      },
      "description": "Links relevant to the payload."
    },
    "Meta": {
      "title": "MetaData",
      "type": "object",
      "properties": {
        "TotalPages": {
          "type": "integer",
          "description": "Used for pagination. Indicates how many pages of results are available.",
          "format": "int32"
        }
      },
      "description": "Meta data relevant to the payload."
    },
    "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"
      ]
    },
    "OBExchangeRate1": {
      "required": [
        "RateType",
        "UnitCurrency"
      ],
      "type": "object",
      "properties": {
        "UnitCurrency": {
          "pattern": "^[A-Z]{3,3}$",
          "type": "string",
          "description": "The currency that the exchange rate is expressed in.\nFor example, for 1 GBP = xxx EUR, the `UnitCurrency` value is GBP."
        },
        "ExchangeRate": {
          "type": "number",
          "description": "The exchange rate used to convert an amount from one currency into another.\nThis reflects the price that one currency was bought at with another currency.\n"
        },
        "RateType": {
          "$ref": "#/$defs/OBExchangeRateType2Code"
        },
        "ContractIdentification": {
          "maxLength": 256,
          "minLength": 1,
          "type": "string",
          "description": "The unique reference to the foreign exchange contract agreed between the initiating party/creditor and the debtor agent."
        }
      },
      "description": "The details on the currency exchange rate and contract."
    },
    "OBExchangeRate2": {
      "required": [
        "ExchangeRate",
        "RateType",
        "UnitCurrency"
      ],
      "type": "object",
      "properties": {
        "UnitCurrency": {
          "pattern": "^[A-Z]{3,3}$",
          "type": "string",
          "description": "The currency that the exchange rate is expressed in.\nFor example, for 1 GBP = xxx EUR, the `UnitCurrency` value is GBP."
        },
        "ExchangeRate": {
          "type": "string",
          "pattern": "^[0-9]+\\.[0-9]+$",
          "description": "The exchange rate used to convert an amount from one currency into another.\nThis reflects the price that one currency was bought at with another currency."
        },
        "RateType": {
          "$ref": "#/$defs/OBExchangeRateType2Code"
        },
        "ContractIdentification": {
          "maxLength": 256,
          "minLength": 1,
          "type": "string",
          "description": "The unique reference to the foreign exchange contract agreed between the initiating party/creditor and the debtor agent."
        },
        "ExpirationDateTime": {
          "type": "string",
          "description": "The date and time when the exchange rate agreement expires.\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"
        }
      },
      "description": "Further detailed information on the exchange rate that is used in the payment transaction."
    },
    "OBExchangeRateType2Code": {
      "type": "string",
      "description": "The type used to complete the currency exchange.",
      "enum": [
        "Actual",
        "Agreed",
        "Indicative"
      ]
    },
    "OBExternalAccountIdentification4Code": {
      "type": "string",
      "description": "The name of the identification scheme.",
      "enum": [
        "UK.OBIE.IBAN",
        "UK.OBIE.SortCodeAccountNumber",
        "US.RoutingNumberAccountNumber",
        "US.BranchCodeAccountNumber"
      ]
    },
    "OBExternalConsentStatus1Code": {
      "type": "string",
      "description": "The status of the consent.",
      "enum": [
        "Authorised",
        "AwaitingAuthorisation",
        "Consumed",
        "Rejected"
      ]
    },
    "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"
      ]
    },
    "OBExternalPermissions2Code": {
      "type": "string",
      "description": "The Open Banking service request type.",
      "enum": [
        "Create"
      ]
    },
    "OBInternationalScheduled2": {
      "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 a single scheduled international payment.",
      "allOf": [
        {
          "$ref": "#/$defs/OBInternationalScheduledBase"
        },
        {
          "type": "object",
          "properties": {
            "DebtorAccount": {
              "$ref": "#/$defs/OBCashAccountDebtor4"
            }
          }
        },
        {
          "type": "object",
          "required": [
            "CreditorAccount",
            "CurrencyOfTransfer",
            "InstructedAmount",
            "InstructionIdentification",
            "RequestedExecutionDateTime"
          ]
        }
      ]
    },
    "OBInternationalScheduledBase": {
      "type": "object",
      "properties": {
        "InstructionIdentification": {
          "maxLength": 35,
          "minLength": 1,
          "type": "string",
          "description": "The unique ID that an instructing party assigns for an instructed party to unambiguously identify the instruction.\n\nThis ID is used between the instructing party and the instructed party to refer to the individual instruction.\nIt can be included in the messages related to the instruction."
        },
        "EndToEndIdentification": {
          "maxLength": 35,
          "minLength": 1,
          "type": "string",
          "description": "The unique and immutable ID that the initiating party assigns to unambiguously identify the transaction.\n\nThis ID is used for reconciliation or to link tasks related to the transaction.\nIt can be included in the messages related to the transaction.\n\n:::note\nFaster Payments Scheme can access only 31 characters for the `EndToEndIdentification` field.\n:::"
        },
        "ChargeBearer": {
          "$ref": "#/$defs/OBChargeBearerType1Code"
        },
        "RequestedExecutionDateTime": {
          "type": "string",
          "description": "The date and time when the initiating party requests the clearing agent to process the payment.\nThis is the date the debtor's account is to be debited.\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"
        },
        "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."
        },
        "ExchangeRateInformation": {
          "$ref": "#/$defs/OBExchangeRate1"
        },
        "Creditor": {
          "$ref": "#/$defs/OBPartyIdentification43"
        },
        "CreditorAgent": {
          "$ref": "#/$defs/OBBranchAndFinancialInstitutionIdentification6"
        },
        "CreditorAccount": {
          "$ref": "#/$defs/OBCashAccountCreditor3"
        },
        "RemittanceInformation": {
          "$ref": "#/$defs/OBRemittanceInformation1"
        }
      },
      "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 a single scheduled international payment."
    },
    "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."
    },
    "OBRemittanceInformation1": {
      "type": "object",
      "properties": {
        "Unstructured": {
          "maxLength": 140,
          "minLength": 1,
          "type": "string",
          "description": "The information used for matching/reconciliation of an entry with the items that the payment is intended to settle, such as commercial invoices in an accounts' receivable system, in an unstructured form."
        },
        "Reference": {
          "maxLength": 35,
          "minLength": 1,
          "type": "string",
          "description": "The unique reference that the creditor assigns to unambiguously identify 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.\n\n:::note\nFaster Payments Scheme can accept only 18 characters for the `Reference` field.\n:::\n\n:::warning\nOnly one reference should be provided, if both `Reference` and `Unstructured` parameters are provided, then the `Unstructured` parameter will be ignored.\n:::"
        }
      },
      "description": "The information used for matching an entry with the items that the transfer is intended to settle, such as commercial invoices in an accounts' receivable system."
    },
    "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."
    },
    "OBWriteDataInternationalScheduledConsentResponse2": {
      "required": [
        "ConsentId",
        "CreationDateTime",
        "Initiation",
        "Permission",
        "Status",
        "StatusUpdateDateTime"
      ],
      "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."
        },
        "CreationDateTime": {
          "type": "string",
          "description": "The date and time when the resource was created.\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"
        },
        "Status": {
          "$ref": "#/$defs/OBExternalConsentStatus1Code"
        },
        "StatusUpdateDateTime": {
          "type": "string",
          "description": "The date and time when the resource status was updated.\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"
        },
        "Permission": {
          "$ref": "#/$defs/OBExternalPermissions2Code"
        },
        "ExchangeRateInformation": {
          "$ref": "#/$defs/OBExchangeRate2"
        },
        "Initiation": {
          "$ref": "#/$defs/OBInternationalScheduled2"
        }
      }
    }
  }
}