{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://raw.githubusercontent.com/api-evangelist/revolut/main/json-schema/revolut-obwrite-file-response2-schema.json",
  "title": "OBWriteFileResponse2",
  "x-generated": "2026-10-12",
  "x-method": "derived",
  "x-generator": "derive-json-schema.py",
  "x-source": "openapi/revolut-file-payment-api-openapi.yml#/components/schemas/OBWriteFileResponse2",
  "required": [
    "Data",
    "Links",
    "Meta"
  ],
  "type": "object",
  "properties": {
    "Data": {
      "$ref": "#/$defs/OBWriteDataFileResponse2"
    },
    "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."
    },
    "OBCashAccountDebtorResponse": {
      "required": [
        "Identification",
        "SchemeName"
      ],
      "type": "object",
      "description": "The details to identify the account which was used to approve the payment consent.\n\nThis information can be used as a refund address.",
      "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[Name validation]\nThis field will only return the actual owner(s) name if `DebtorAccount` was not defined in the consent.\n\nIf it was defined in the consent, the same value from the consent will be returned.\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."
        }
      }
    },
    "OBExternalAccountIdentification4Code": {
      "type": "string",
      "description": "The name of the identification scheme.",
      "enum": [
        "UK.OBIE.IBAN",
        "UK.OBIE.SortCodeAccountNumber",
        "US.RoutingNumberAccountNumber",
        "US.BranchCodeAccountNumber"
      ]
    },
    "OBExternalFileType1Code": {
      "type": "string",
      "description": "The payment file type."
    },
    "OBExternalLocalInstrument1Code": {
      "maxLength": 50,
      "minLength": 1,
      "type": "string",
      "description": "User community specific instrument.\n\nUse this element to specify a local instrument, local clearing option and/or further qualify the service or service level."
    },
    "OBExternalStatus1Code": {
      "type": "string",
      "description": "The status of the payment.",
      "enum": [
        "InitiationCompleted",
        "InitiationFailed",
        "InitiationPending"
      ]
    },
    "OBFileBase": {
      "type": "object",
      "properties": {
        "FileType": {
          "$ref": "#/$defs/OBExternalFileType1Code"
        },
        "FileHash": {
          "maxLength": 44,
          "minLength": 1,
          "type": "string",
          "description": "A base64 encoding of a SHA256 hash of the file to be uploaded."
        },
        "FileReference": {
          "maxLength": 40,
          "minLength": 1,
          "type": "string",
          "description": "Reference for the file."
        },
        "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"
        },
        "LocalInstrument": {
          "$ref": "#/$defs/OBExternalLocalInstrument1Code"
        },
        "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 using a payment file."
    },
    "OBFileInitiationResponse": {
      "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 using a payment file.",
      "allOf": [
        {
          "$ref": "#/$defs/OBFileBase"
        },
        {
          "type": "object",
          "properties": {
            "DebtorAccount": {
              "$ref": "#/$defs/OBCashAccountDebtorResponse"
            }
          }
        },
        {
          "type": "object",
          "required": [
            "FileHash",
            "FileType",
            "DebtorAccount"
          ]
        }
      ]
    },
    "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."
    },
    "OBWriteDataFileResponse2": {
      "required": [
        "ConsentId",
        "CreationDateTime",
        "FilePaymentId",
        "Initiation",
        "Status",
        "StatusUpdateDateTime"
      ],
      "type": "object",
      "properties": {
        "FilePaymentId": {
          "maxLength": 40,
          "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 file payment resource."
        },
        "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 message 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/OBExternalStatus1Code"
        },
        "StatusUpdateDateTime": {
          "type": "string",
          "description": "The date and time when the consent 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"
        },
        "Initiation": {
          "$ref": "#/$defs/OBFileInitiationResponse"
        }
      }
    }
  }
}