Create a Check Transfer

v1.0.0

Input

{
  "type": "object",
  "required": [
    "account_id",
    "address_city",
    "address_line1",
    "address_state",
    "address_zip",
    "amount",
    "message",
    "recipient_name"
  ],
  "properties": {
    "account_id": {
      "type": "string",
      "description": "The identifier for the account that will send the transfer."
    },
    "address_city": {
      "type": "string",
      "description": "The city of the check's destination."
    },
    "address_line1": {
      "type": "string",
      "description": "The street address of the check's destination."
    },
    "address_line2": {
      "type": "string",
      "description": "The second line of the address of the check's destination."
    },
    "address_state": {
      "type": "string",
      "description": "The state of the check's destination."
    },
    "address_zip": {
      "type": "string",
      "description": "The postal code of the check's destination."
    },
    "amount": {
      "type": "integer",
      "description": "The transfer amount in cents."
    },
    "message": {
      "type": "string",
      "description": "The descriptor that will be printed on the memo field on the check."
    },
    "note": {
      "type": "string",
      "description": "The descriptor that will be printed on the letter included with the check."
    },
    "recipient_name": {
      "type": "string",
      "description": "The name that will be printed on the check."
    },
    "require_approval": {
      "type": "boolean",
      "description": "Whether the transfer requires explicit approval via the dashboard or API."
    },
    "return_address": {
      "type": "object",
      "description": "The return address to be printed on the check. If omitted this will default to the address of the Entity of the Account used to make the Check Transfer.",
      "required": [
        "city",
        "line1",
        "name",
        "state",
        "zip"
      ],
      "properties": {
        "city": {
          "type": "string",
          "description": "The city of the return address."
        },
        "line1": {
          "type": "string",
          "description": "The first line of the return address."
        },
        "line2": {
          "type": "string",
          "description": "The second line of the return address."
        },
        "name": {
          "type": "string",
          "description": "The name of the return address."
        },
        "state": {
          "type": "string",
          "description": "The US state of the return address."
        },
        "zip": {
          "type": "string",
          "description": "The postal code of the return address."
        }
      }
    }
  }
}

Output

{
  "type": "object",
  "description": "Check Transfers move funds from your Increase account by mailing a physical check.",
  "required": [
    "account_id",
    "address_city",
    "address_line1",
    "address_line2",
    "address_state",
    "address_zip",
    "amount",
    "created_at",
    "currency",
    "deposit",
    "id",
    "mailed_at",
    "message",
    "note",
    "recipient_name",
    "return_address",
    "status",
    "stop_payment_request",
    "submission",
    "submitted_at",
    "template_id",
    "transaction_id",
    "type"
  ],
  "properties": {
    "account_id": {
      "type": "string",
      "description": "The identifier of the Account from which funds will be transferred."
    },
    "address_city": {
      "type": "string",
      "description": "The city of the check's destination."
    },
    "address_line1": {
      "type": "string",
      "description": "The street address of the check's destination."
    },
    "address_line2": {
      "type": "string",
      "description": "The second line of the address of the check's destination."
    },
    "address_state": {
      "type": "string",
      "description": "The state of the check's destination."
    },
    "address_zip": {
      "type": "string",
      "description": "The postal code of the check's destination."
    },
    "amount": {
      "type": "integer",
      "description": "The transfer amount in USD cents."
    },
    "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 check's currency.",
      "enum": [
        "CAD",
        "CHF",
        "EUR",
        "GBP",
        "JPY",
        "USD"
      ]
    },
    "deposit": {
      "type": "object",
      "description": "After a check transfer is deposited, this will contain supplemental details.",
      "required": [
        "back_image_file_id",
        "front_image_file_id",
        "type"
      ],
      "properties": {
        "back_image_file_id": {
          "type": "string",
          "description": "The ID for the File containing the image of the rear of the check."
        },
        "front_image_file_id": {
          "type": "string",
          "description": "The ID for the File containing the image of the front of the check."
        },
        "type": {
          "type": "string",
          "description": "A constant representing the object's type. For this resource it will always be `check_transfer_deposit`.",
          "enum": [
            "check_transfer_deposit"
          ]
        }
      }
    },
    "id": {
      "type": "string",
      "description": "The Check transfer's identifier."
    },
    "mailed_at": {
      "type": "string",
      "format": "date-time",
      "description": "The [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) date and time at which the check was mailed."
    },
    "message": {
      "type": "string",
      "description": "The descriptor that will be printed on the memo field on the check."
    },
    "note": {
      "type": "string",
      "description": "The descriptor that will be printed on the letter included with the check."
    },
    "recipient_name": {
      "type": "string",
      "description": "The name that will be printed on the check."
    },
    "return_address": {
      "type": "object",
      "description": "The return address to be printed on the check.",
      "required": [
        "city",
        "line1",
        "line2",
        "name",
        "state",
        "zip"
      ],
      "properties": {
        "city": {
          "type": "string",
          "description": "The city of the address."
        },
        "line1": {
          "type": "string",
          "description": "The first line of the address."
        },
        "line2": {
          "type": "string",
          "description": "The second line of the address."
        },
        "name": {
          "type": "string",
          "description": "The name of the address."
        },
        "state": {
          "type": "string",
          "description": "The US state of the address."
        },
        "zip": {
          "type": "string",
          "description": "The postal code of the address."
        }
      }
    },
    "status": {
      "type": "string",
      "description": "The lifecycle status of the transfer.",
      "enum": [
        "pending_approval",
        "pending_submission",
        "submitting",
        "submitted",
        "pending_mailing",
        "mailed",
        "canceled",
        "deposited",
        "stopped",
        "returned",
        "rejected",
        "requires_attention"
      ]
    },
    "stop_payment_request": {
      "type": "object",
      "description": "After a stop-payment is requested on the check, this will contain supplemental details.",
      "required": [
        "requested_at",
        "transaction_id",
        "transfer_id",
        "type"
      ],
      "properties": {
        "requested_at": {
          "type": "string",
          "format": "date-time",
          "description": "The time the stop-payment was requested."
        },
        "transaction_id": {
          "type": "string",
          "description": "The transaction ID of the corresponding credit transaction."
        },
        "transfer_id": {
          "type": "string",
          "description": "The ID of the check transfer that was stopped."
        },
        "type": {
          "type": "string",
          "description": "A constant representing the object's type. For this resource it will always be `check_transfer_stop_payment_request`.",
          "enum": [
            "check_transfer_stop_payment_request"
          ]
        }
      }
    },
    "submission": {
      "type": "object",
      "description": "After the transfer is submitted, this will contain supplemental details.",
      "required": [
        "check_number"
      ],
      "properties": {
        "check_number": {
          "type": "string",
          "description": "The identitying number of the check."
        }
      }
    },
    "submitted_at": {
      "type": "string",
      "format": "date-time",
      "description": "The [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) date and time at which the check was submitted."
    },
    "template_id": {
      "type": "string",
      "description": "If the transfer was created from a template, this will be the template's ID."
    },
    "transaction_id": {
      "type": "string",
      "description": "The ID for the transaction caused by the transfer."
    },
    "type": {
      "type": "string",
      "description": "A constant representing the object's type. For this resource it will always be `check_transfer`.",
      "enum": [
        "check_transfer"
      ]
    }
  }
}