Sign in

v47

latestOpenAPI 3.1.0raw.githubusercontent.com2026-05-012382333.4 MB

Create a Check Transfer

post/check_transfers

Request body

account_idstring required

The identifier for the account that will send the transfer.

amountinteger required

The transfer amount in USD cents.

balance_check'full' | 'none'

How the account's available balance should be checked. If omitted, the default behavior is balance_check: full.

check_numberstring

The check number Increase should use for the check. This should not contain leading zeroes and must be unique across the source_account_number. If this is omitted, Increase will generate a check number for you.

fulfillment_method'physical_check' | 'third_party' required

Whether Increase will print and mail the check or if you will do it yourself.

require_approvalboolean

Whether the transfer requires explicit approval via the dashboard or API.

source_account_number_idstring required

The identifier of the Account Number from which to send the transfer and print on the check.

valid_until_datestring date

If provided, the check will be valid on or before this date. After this date, the check transfer will be automatically stopped and deposits will not be accepted. For checks printed by Increase, this date is included on the check as its expiry.

Example request

{
  "account_id": "account_in71c4amph0vgo2qllky",
  "amount": 1000,
  "fulfillment_method": "physical_check",
  "physical_check": {
    "mailing_address": {
      "city": "New York",
      "line1": "33 Liberty Street",
      "name": "Ian Crease",
      "phone": "+16505046304",
      "postal_code": "10045",
      "state": "NY"
    },
    "memo": "Check payment",
    "recipient_name": "Ian Crease",
    "return_address": null,
    "signature": {
      "text": "Ian Crease"
    }
  },
  "source_account_number_id": "account_number_v18nkfqm6afpsrvy82b2",
  "valid_until_date": "2025-12-31"
}

Response

Check Transfer

account_idstring required

The identifier of the Account from which funds will be transferred.

account_numberstring required

The account number printed on the check.

amountinteger required

The transfer amount in USD cents.

approved_inbound_check_deposit_idstring nullable required

If the Check Transfer was successfully deposited, this will contain the identifier of the Inbound Check Deposit object with details of the deposit.

balance_check'full' | 'none' nullable required

How the account's available balance should be checked.

check_numberstring required

The check number printed on the check.

created_atstring date-time required

The ISO 8601 date and time at which the transfer was created.

currency'USD' required

The ISO 4217 code for the check's currency.

fulfillment_method'physical_check' | 'third_party' required

Whether Increase will print and mail the check or if you will do it yourself.

idstring required

The Check transfer's identifier.

idempotency_keystring nullable required

The idempotency key you chose for this object. This value is unique across Increase and is used to ensure that a request is only processed once. Learn more about idempotency.

pending_transaction_idstring nullable required

The ID for the pending transaction representing the transfer. A pending transaction is created when the transfer requires approval by someone else in your organization.

routing_numberstring required

The routing number printed on the check.

source_account_number_idstring nullable required

The identifier of the Account Number from which to send the transfer and print on the check.

status'pending_approval' | 'canceled' | 'pending_submission' | 'requires_attention' | 'rejected' | 'pending_mailing' | 'mailed' | 'deposited' | 'stopped' | 'returned' required

The lifecycle status of the transfer.

type'check_transfer' required

A constant representing the object's type. For this resource it will always be check_transfer.

valid_until_datestring date nullable required

If set, the check will be valid on or before this date. After this date, the check transfer will be automatically stopped and deposits will not be accepted. For checks printed by Increase, this date is included on the check as its expiry.

Example response

{
  "account_id": "account_in71c4amph0vgo2qllky",
  "account_number": "987654321",
  "amount": 1000,
  "approval": null,
  "approved_inbound_check_deposit_id": "inbound_check_deposit_zoshvqybq0cjjm31mra",
  "balance_check": null,
  "cancellation": null,
  "check_number": "123",
  "created_at": "2020-01-31T23:59:59Z",
  "created_by": {
    "category": "user",
    "user": {
      "email": "user@example.com"
    }
  },
  "currency": "USD",
  "fulfillment_method": "physical_check",
  "id": "check_transfer_30b43acfu9vw8fyc4f5",
  "idempotency_key": null,
  "mailing": {
    "mailed_at": "2020-01-31T23:59:59Z"
  },
  "pending_transaction_id": "pending_transaction_k1sfetcau2qbvjbzgju4",
  "physical_check": {
    "attachment_file_id": null,
    "check_voucher_image_file_id": null,
    "mailing_address": {
      "city": "New York",
      "line1": "33 Liberty Street",
      "line2": null,
      "name": "Ian Crease",
      "phone": "+16505046304",
      "postal_code": "10045",
      "state": "NY"
    },
    "memo": "Invoice 29582",
    "note": null,
    "payer": [
      {
        "contents": "Ian Crease"
      },
      {
        "contents": "33 Liberty Street"
      },
      {
        "contents": "New York, NY 10045"
      }
    ],
    "recipient_name": "Ian Crease",
    "return_address": {
      "city": "New York",
      "line1": "33 Liberty Street",
      "line2": null,
      "name": "Ian Crease",
      "phone": "+16505046304",
      "postal_code": "10045",
      "state": "NY"
    },
    "shipping_method": null,
    "signature": {
      "image_file_id": null,
      "text": "Ian Crease"
    },
    "tracking_updates": []
  },
  "routing_number": "101050001",
  "source_account_number_id": "account_number_v18nkfqm6afpsrvy82b2",
  "status": "mailed",
  "stop_payment_request": null,
  "submission": {
    "preview_file_id": null,
    "submitted_address": {
      "city": "NEW YORK",
      "line1": "33 LIBERTY STREET",
      "line2": null,
      "recipient_name": "IAN CREASE",
      "state": "NY",
      "zip": "10045"
    },
    "submitted_at": "2020-01-31T23:59:59Z",
    "tracking_number": null
  },
  "third_party": null,
  "type": "check_transfer",
  "valid_until_date": null
}