{
  "type": "array",
  "items": {
    "$ref": "#/components/schemas/UnexpectedError"
  },
  "title": "Unexpected Error",
  "description": "This error occurs when we (Belvo) have encountered an internal system error (sorry about that) or due to an unsupported response from the institution.\n  \n"
}

{
  "type": "array",
  "items": {
    "oneOf": [
      {
        "$ref": "#/components/schemas/Transaction"
      },
      {
        "$ref": "#/components/schemas/TransactionOpenFinanceBrazil"
      }
    ]
  }
}

{
  "type": "array",
  "items": {
    "anyOf": [
      {
        "$ref": "#/components/schemas/UnauthorizedError"
      },
      {
        "$ref": "#/components/schemas/401_consent_without_accounts_error"
      }
    ]
  }
}

{
  "type": "array",
  "items": {
    "$ref": "#/components/schemas/NotFoundError"
  },
  "description": "You made a request where you:\n\n  - provided the wrong URL.\n  - used an ID (for a link, account, transaction, and so on) that is not associated with your Belvo account.\n  \n"
}

{
  "oneOf": [
    {
      "$ref": "#/components/schemas/Transaction"
    },
    {
      "$ref": "#/components/schemas/TransactionOpenFinanceBrazil"
    }
  ]
}

{
  "type": "array",
  "items": {
    "anyOf": [
      {
        "$ref": "#/components/schemas/UnauthorizedError"
      },
      {
        "$ref": "#/components/schemas/401_consent_without_accounts_error"
      }
    ]
  }
}

{
  "oneOf": [
    {
      "$ref": "#/components/schemas/TransactionsPaginatedResponse"
    },
    {
      "$ref": "#/components/schemas/TransactionsPaginatedResponseOpenFinanceBrazil"
    }
  ]
}

{
  "type": "object",
  "allOf": [
    {
      "$ref": "#/components/schemas/common_pagination_properties"
    },
    {
      "properties": {
        "results": {
          "type": "array",
          "items": {
            "$ref": "#/components/schemas/Transaction"
          },
          "description": "Array of transaction objects (Multi-Region)."
        }
      }
    }
  ],
  "title": "Transactions Standard (Multi-Region)"
}

{
  "type": "object",
  "allOf": [
    {
      "$ref": "#/components/schemas/common_pagination_properties"
    },
    {
      "properties": {
        "results": {
          "type": "array",
          "items": {
            "$ref": "#/components/schemas/TransactionOpenFinanceBrazil"
          },
          "description": "Array of transaction objects (OFDA Brazil)."
        }
      }
    }
  ],
  "title": "Transactions (OFDA Brazil)"
}

{
  "type": "array",
  "items": {
    "$ref": "#/components/schemas/NotFoundError"
  },
  "description": "You made a request where you:\n\n  - provided the wrong URL.\n  - used an ID (for a link, account, transaction, and so on) that is not associated with your Belvo account.\n  \n"
}

{
  "type": "array",
  "items": {
    "anyOf": [
      {
        "$ref": "#/components/schemas/UnauthorizedError"
      },
      {
        "$ref": "#/components/schemas/401_consent_without_accounts_error"
      }
    ]
  }
}

{
  "type": "object",
  "required": [
    "link",
    "date_from",
    "date_to"
  ],
  "properties": {
    "link": {
      "type": "string",
      "format": "uuid",
      "example": "2ccd5e15-194a-4a19-a45a-e7223c7e6717",
      "description": "The `link.id` that you want to get information for."
    },
    "token": {
      "type": "string",
      "example": "1234ab",
      "description": "The OTP token generated by the bank."
    },
    "account": {
      "type": "string",
      "format": "uuid",
      "example": "d4617561-1c01-4b2f-83b6-a594f7b3bc57",
      "description": "If provided, we return transactions only from this account."
    },
    "date_to": {
      "type": "string",
      "example": "2020-10-05",
      "pattern": "[0-9]{4}-[0-9]{2}-[0-9]{2}",
      "description": "The date you want to stop getting transactions for, in `YYYY-MM-DD` format.\n\n\n⚠️ The value of `date_to` cannot be greater than today's date (in other words, no future dates).\n"
    },
    "date_from": {
      "type": "string",
      "example": "2020-08-05",
      "pattern": "[0-9]{4}-[0-9]{2}-[0-9]{2}",
      "description": "The date from which you want to start getting transactions for, in `YYYY-MM-DD` format.\n\n\n⚠️ The value of `date_from` cannot be greater than `date_to`.\n"
    },
    "save_data": {
      "type": "boolean",
      "default": true,
      "description": "Indicates whether or not to persist the data in Belvo. By default, this is set to `true` and we return a 201 Created response.\n\nWhen set to `false`, the data won't be persisted and we return a 200 OK response.\n"
    }
  }
}

{
  "type": "array",
  "items": {
    "oneOf": [
      {
        "$ref": "#/components/schemas/Transaction"
      },
      {
        "$ref": "#/components/schemas/TransactionOpenFinanceBrazil"
      }
    ]
  }
}

{
  "type": "array",
  "items": {
    "anyOf": [
      {
        "$ref": "#/components/schemas/TooManySessionsError"
      },
      {
        "$ref": "#/components/schemas/LoginError"
      },
      {
        "$ref": "#/components/schemas/SessionExpiredError"
      },
      {
        "$ref": "#/components/schemas/ValidationError"
      },
      {
        "$ref": "#/components/schemas/InstitutionDownError"
      },
      {
        "$ref": "#/components/schemas/InstitutionUnavailableError"
      },
      {
        "$ref": "#/components/schemas/InstitutionInactiveError"
      },
      {
        "$ref": "#/components/schemas/UnsupportedOperationError"
      },
      {
        "$ref": "#/components/schemas/InvalidLinkError"
      },
      {
        "$ref": "#/components/schemas/UnconfirmedLinkError"
      }
    ]
  }
}

{
  "type": "array",
  "items": {
    "anyOf": [
      {
        "$ref": "#/components/schemas/UnauthorizedError"
      },
      {
        "$ref": "#/components/schemas/401_consent_without_accounts_error"
      }
    ]
  }
}

{
  "type": "array",
  "items": {
    "$ref": "#/components/schemas/RequestTimeoutError"
  },
  "title": "Request Timeout",
  "description": "Belvo has a limit regarding the time it takes to log in, retrieve account data, and log out. A timeout occurs when there is a very high amount of data and everything could not be obtained within the allotted time.\n  \n"
}

{
  "type": "array",
  "items": {
    "$ref": "#/components/schemas/TokenRequiredResponse"
  }
}

{
  "type": "array",
  "items": {
    "$ref": "#/components/schemas/UnexpectedError"
  },
  "title": "Unexpected Error",
  "description": "This error occurs when we (Belvo) have encountered an internal system error (sorry about that) or due to an unsupported response from the institution.\n  \n"
}

{
  "type": "array",
  "items": {
    "oneOf": [
      {
        "$ref": "#/components/schemas/Transaction"
      },
      {
        "$ref": "#/components/schemas/TransactionOpenFinanceBrazil"
      }
    ]
  }
}

{
  "type": "object",
  "title": "Unauthorized Error",
  "properties": {
    "code": {
      "type": "string",
      "example": "authentication_failed",
      "description": "A unique error code (`authentication_failed`) that allows you to classify and handle the error programmatically.\n\n\nℹ️ Check our DevPortal for more information on how to handle <a href=\"https://developers.belvo.com/docs/belvo-api-errors#401-authentication_failed\" target=\"_blank\">401 authentication_failed errors</a>.\n"
    },
    "message": {
      "type": "string",
      "example": "Invalid Secret Keys",
      "description": "A short description of the error. \n\n\nFor `authentication_failed` errors, the description is:\n\n  - `Invalid Secret Keys`.\n"
    },
    "request_id": {
      "type": "string",
      "example": "9e7b283c6efa449c9c028a16b5c249fb",
      "pattern": "[a-f0-9]{32}",
      "description": "A 32-character unique ID of the request (matching a regex pattern of: `[a-f0-9]{32}`). Provide this ID when contacting the Belvo\nsupport team to accelerate investigations.\n"
    }
  },
  "description": "This error occurs when you try to make an API call using incorrect Belvo API credentials (either your secret key or secret password, or both, are incorrect).\n"
}

{
  "type": "object",
  "title": "Unconfirmed Link",
  "properties": {
    "code": {
      "type": "string",
      "example": "unconfirmed_link",
      "description": "A unique error code (`unconfirmed_link`) that allows you to classify and handle the error programmatically.\n\n\nℹ️ Check our DevPortal for more information on how to handle <a href=\"https://developers.belvo.com/docs/belvo-api-errors#400-unconfirmed_link\" target=\"_blank\">400 unconfirmed_link errors</a>.\n"
    },
    "message": {
      "type": "string",
      "example": "The link creation has not been completed yet",
      "description": "A short description of the error. \n\n\nFor `unconfirmed_link` errors, the description is:\n  \n  - `The link creation has not been completed yet`.\n"
    },
    "request_id": {
      "type": "string",
      "example": "9e7b283c6efa449c9c028a16b5c249fb",
      "pattern": "[a-f0-9]{32}",
      "description": "A 32-character unique ID of the request (matching a regex pattern of: `[a-f0-9]{32}`). Provide this ID when contacting the Belvo\nsupport team to accelerate investigations.\n"
    }
  },
  "description": "This error occurs when you try to access a link that was paused previously (and as such is not active now).\n\nA Link's status is set to `unconfirmed_link` when your user has not completed the Link creation process successfully (for example, they might not provide a valid MFA token).\n"
}

{
  "type": "object",
  "title": "Unexpected Error",
  "properties": {
    "code": {
      "type": "string",
      "example": "unexpected_error",
      "description": "A unique error code (`unexpected_error`) that allows you to classify and handle the error programmatically.\n\n\nℹ️ Check our DevPortal for more information on how to handle <a href=\"https://developers.belvo.com/docs/belvo-api-errors#500-unexpected_error\" target=\"_blank\">500 unexpected_error errors</a>.\n"
    },
    "message": {
      "type": "string",
      "example": "Belvo is unable to process the request due to an internal system issue or to an unsupported response from an institution",
      "description": "A short description of the error. \n\n\nFor `unexpected_error` errors, the description is:\n  \n  - `Belvo is unable to process the request due to an internal system issue or to an unsupported response from an institution`.\n"
    },
    "request_id": {
      "type": "string",
      "example": "9e7b283c6efa449c9c028a16b5c249fb",
      "pattern": "[a-f0-9]{32}",
      "description": "A 32-character unique ID of the request (matching a regex pattern of: `[a-f0-9]{32}`). Provide this ID when contacting the Belvo\nsupport team to accelerate investigations.\n"
    }
  },
  "description": "This error occurs when we (Belvo) have encountered an internal system error (sorry about that) or due to an unsupported response from the institution.\n"
}

{
  "type": "object",
  "title": "Unsupported Operation",
  "properties": {
    "code": {
      "type": "string",
      "example": "unsupported_operation",
      "description": "A unique error code (`unsupported_operation`) that allows you to classify and handle the error programmatically.\n\n\nℹ️ Check our DevPortal for more information on how to handle <a href=\"https://developers.belvo.com/docs/belvo-api-errors#400-unsupported_operation\" target=\"_blank\">400 unsupported_operation errors</a>.\n"
    },
    "message": {
      "type": "string",
      "example": "The resource you are trying to access is not supported by this institution",
      "description": "A short description of the error. \n\n\nFor `unsupported_operation` errors, the description is:\n  \n  - `The resource you are trying to access is not supported by this institution`.\n"
    },
    "request_id": {
      "type": "string",
      "example": "9e7b283c6efa449c9c028a16b5c249fb",
      "pattern": "[a-f0-9]{32}",
      "description": "A 32-character unique ID of the request (matching a regex pattern of: `[a-f0-9]{32}`). Provide this ID when contacting the Belvo\nsupport team to accelerate investigations.\n"
    }
  },
  "description": "This error occurs when you try to access some data operation that Belvo does not support for an institution. For example, trying to access the Balances resource for fiscal institutions.\n"
}

{
  "type": "object",
  "title": "Validation Error",
  "properties": {
    "code": {
      "type": "string",
      "example": "required",
      "description": "A unique error code (`null`, `does_not_exist`, `required`) that allows you to classify and handle the error programmatically.\n\n\nℹ️ Check our DevPortal for more information on how to handle:\n  - <a href=\"https://developers.belvo.com/docs/belvo-api-errors#400-blank\" target=\"_blank\">400 blank errors</a>\n  - <a href=\"https://developers.belvo.com/docs/belvo-api-errors#400-null\" target=\"_blank\">400 null errors</a>\n  - <a href=\"https://developers.belvo.com/docs/belvo-api-errors#400-does_not_exist\" target=\"_blank\">400 does_not_exist errors</a>\n  - <a href=\"https://developers.belvo.com/docs/belvo-api-errors#400-required\" target=\"_blank\">400 required errors</a>\n"
    },
    "field": {
      "type": "string",
      "example": "link",
      "nullable": true,
      "description": "Name of the field where the error was encountered.\n"
    },
    "message": {
      "type": "string",
      "example": "This field is required.",
      "description": "A short description of the error. \n\n\nFor validation errors, the description can be (among others):\n  \n  - `This field is required.`\n  - `Object with name=narnia does not exist.`\n  - `This field may not be null.`\n  - `This field may not be blank.`\n"
    },
    "request_id": {
      "type": "string",
      "example": "9e7b283c6efa449c9c028a16b5c249fb",
      "pattern": "[a-f0-9]{32}",
      "description": "A 32-character unique ID of the request (matching a regex pattern of: `[a-f0-9]{32}`). Provide this ID when contacting the Belvo\nsupport team to accelerate investigations.\n"
    }
  },
  "description": "This error occurs when make a request that does not include all the required fields or includes invalid data.\n"
}

{
  "type": "object",
  "properties": {
    "next": {
      "type": "string",
      "format": "uri",
      "example": "https://sandbox.belvo.com/api/{endpoint}/?page=2",
      "nullable": true,
      "description": "The URL to next page of results. Each page consists of up to 100 items. If there are not enough results for an additional page, the value is `null`.\n\nIn our documentation example, we use `{endpoint}` as a placeholder value. In production, this value will be replaced by the actual endpoint you are currently using (for example, `accounts` or `owners`).\n"
    },
    "count": {
      "type": "integer",
      "format": "int32",
      "example": 130,
      "description": "The total number of results in your Belvo account."
    },
    "previous": {
      "type": "string",
      "format": "uri",
      "example": null,
      "nullable": true,
      "description": "The URL to the previous page of results. If there is no previous page, the\nvalue is `null`.\n"
    }
  }
}