action increase_return_a_sandbox_check_deposit {
  label: "Return a Sandbox Check Deposit"
  description: "Simulates the return of a [Check Deposit](#check-deposits). This Check Deposit must first have a `status` of `submitted`."
  provider: increase
  method: POST
  path: "/simulations/check_deposits/{check_deposit_id}/return"
  encoding: json
  input: {
    type: "object"
    properties: {
      check_deposit_id: {
        type: "string"
        description: "The identifier of the Check Deposit you wish to return."
      }
    }
    required: ["check_deposit_id"]
    additionalProperties: false
  }
  output: {
    type: "object"
    description: "Check Deposits allow you to deposit images of paper checks into your account."
    required: ["account_id", "amount", "back_image_file_id", "created_at", "currency", "deposit_acceptance", "deposit_rejection", "deposit_return", "front_image_file_id", "id", "status", "transaction_id", "type"]
    properties: {
      account_id: {
        type: "string"
        description: "The Account the check was deposited into."
      }
      amount: {
        type: "integer"
        description: "The deposited amount in the minor unit of the destination account currency. For dollars, for example, this is cents."
      }
      back_image_file_id: {
        type: "string"
        description: "The ID for the File containing the image of the back of the check."
      }
      created_at: {
        type: "string"
        format: "date-time"
        description: "The [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) date and time at which the transfer was created."
      }
      currency: {
        type: "string"
        description: "The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the deposit."
        enum: ["CAD", "CHF", "EUR", "GBP", "JPY", "USD"]
      }
      deposit_acceptance: {
        type: "object"
        description: "If your deposit is successfully parsed and accepted by Increase, this will contain details of the parsed check."
        required: ["account_number", "amount", "auxiliary_on_us", "check_deposit_id", "currency", "routing_number", "serial_number"]
        properties: {
          account_number: {
            type: "string"
            description: "The account number printed on the check."
          }
          amount: {
            type: "integer"
            description: "The amount to be deposited in the minor unit of the transaction's currency. For dollars, for example, this is cents."
          }
          auxiliary_on_us: {
            type: "string"
            description: "An additional line of metadata printed on the check. This typically includes the check number for business checks."
          }
          check_deposit_id: {
            type: "string"
            description: "The ID of the Check Deposit that was accepted."
          }
          currency: {
            type: "string"
            description: "The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the transaction's currency."
            enum: ["CAD", "CHF", "EUR", "GBP", "JPY", "USD"]
          }
          routing_number: {
            type: "string"
            description: "The routing number printed on the check."
          }
          serial_number: {
            type: "string"
            description: "The check serial number, if present, for consumer checks. For business checks, the serial number is usually in the `auxiliary_on_us` field."
          }
        }
      }
      deposit_rejection: {
        type: "object"
        description: "If your deposit is rejected by Increase, this will contain details as to why it was rejected."
        required: ["amount", "currency", "reason", "rejected_at"]
        properties: {
          amount: {
            type: "integer"
            description: "The rejected amount in the minor unit of check's currency. For dollars, for example, this is cents."
          }
          currency: {
            type: "string"
            description: "The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the check's currency."
            enum: ["CAD", "CHF", "EUR", "GBP", "JPY", "USD"]
          }
          reason: {
            type: "string"
            description: "Why the check deposit was rejected."
            enum: ["incomplete_image", "duplicate", "poor_image_quality", "incorrect_amount", "incorrect_recipient", "not_eligible_for_mobile_deposit", "unknown"]
          }
          rejected_at: {
            type: "string"
            format: "date-time"
            description: "The [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) date and time at which the check deposit was rejected."
          }
        }
      }
      deposit_return: {
        type: "object"
        description: "If your deposit is returned, this will contain details as to why it was returned."
        required: ["amount", "check_deposit_id", "currency", "return_reason", "returned_at", "transaction_id"]
        properties: {
          amount: {
            type: "integer"
            description: "The amount in the minor unit of the transaction's currency. For dollars, for example, this is cents."
          }
          check_deposit_id: {
            type: "string"
            description: "The identifier of the Check Deposit that was returned."
          }
          currency: {
            type: "string"
            description: "The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the transaction's currency."
            enum: ["CAD", "CHF", "EUR", "GBP", "JPY", "USD"]
          }
          return_reason: {
            type: "string"
            enum: ["ach_conversion_not_supported", "closed_account", "duplicate_submission", "insufficient_funds", "no_account", "not_authorized", "stale_dated", "stop_payment", "unknown_reason", "unmatched_details", "unreadable_image"]
          }
          returned_at: {
            type: "string"
            format: "date-time"
            description: "The [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) date and time at which the check deposit was returned."
          }
          transaction_id: {
            type: "string"
            description: "The identifier of the transaction that reversed the original check deposit transaction."
          }
        }
      }
      front_image_file_id: {
        type: "string"
        description: "The ID for the File containing the image of the front of the check."
      }
      id: {
        type: "string"
        description: "The deposit's identifier."
      }
      status: {
        type: "string"
        description: "The status of the Check Deposit."
        enum: ["pending", "submitted", "rejected", "returned"]
      }
      transaction_id: {
        type: "string"
        description: "The ID for the Transaction created by the deposit."
      }
      type: {
        type: "string"
        description: "A constant representing the object's type. For this resource it will always be `check_deposit`."
        enum: ["check_deposit"]
      }
    }
  }
}