Docs
Guides
Explanatory and how-to content
API Reference
Technical documentation
Changelog
Release notes
Dashboard
Manage your account
Status
Service status
API Reference
Check Transfers

Check Transfers move funds from your Increase account by mailing a physical check.

The Check Transfer object
{
  "account_id": "account_in71c4amph0vgo2qllky",
  "account_number": "987654321",
  "amount": 1000,
  "approval": null,
  "approved_inbound_check_deposit_id": "inbound_check_deposit_zoshvqybq0cjjm31mra",
  "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": {
    "image_id": null,
    "mailed_at": "2020-01-31T23:59:59Z",
    "tracking_number": null
  },
  "pending_transaction_id": "pending_transaction_k1sfetcau2qbvjbzgju4",
  "physical_check": {
    "attachment_file_id": null,
    "mailing_address": {
      "city": "New York",
      "line1": "33 Liberty Street",
      "line2": null,
      "name": "Ian Crease",
      "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",
      "postal_code": "10045",
      "state": "NY"
    },
    "shipping_method": null,
    "signature_text": null,
    "tracking_updates": []
  },
  "routing_number": "101050001",
  "source_account_number_id": "account_number_v18nkfqm6afpsrvy82b2",
  "status": "mailed",
  "stop_payment_request": null,
  "submission": {
    "address_correction_action": "standardization",
    "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"
  },
  "third_party": null,
  "type": "check_transfer"
}
Attributes
account_id
string

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

account_number
string

The account number printed on the check.

amount
integer

The transfer amount in USD cents.

approval
dictionary
Nullable

If your account requires approvals for transfers and the transfer was approved, this will contain details of the approval.

approved_inbound_check_deposit_id
string
Nullable

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

cancellation
dictionary
Nullable

If your account requires approvals for transfers and the transfer was not approved, this will contain details of the cancellation.

check_number
string

The check number printed on the check.

created_at
string

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

created_by
dictionary
Nullable

What object created the transfer, either via the API or the dashboard.

currency
enum

The ISO 4217 code for the check's currency.

fulfillment_method
enum

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

id
string

The Check transfer's identifier.

idempotency_key
string
Nullable

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.

mailing
dictionary
Nullable

If the check has been mailed by Increase, this will contain details of the shipment.

pending_transaction_id
string
Nullable

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.

physical_check
dictionary
Nullable

Details relating to the physical check that Increase will print and mail. Will be present if and only if fulfillment_method is equal to physical_check.

routing_number
string

The routing number printed on the check.

source_account_number_id
string
Nullable

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

status
enum

The lifecycle status of the transfer.

stop_payment_request
dictionary
Nullable

After a stop-payment is requested on the check, this will contain supplemental details.

submission
dictionary
Nullable

After the transfer is submitted, this will contain supplemental details.

third_party
dictionary
Nullable

Details relating to the custom fulfillment you will perform. Will be present if and only if fulfillment_method is equal to third_party.

type
string

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

List Check Transfers
curl \
  --url "${INCREASE_URL}/check_transfers?account_id=account_in71c4amph0vgo2qllky" \
  -H "Authorization: Bearer ${INCREASE_API_KEY}"
Parameters
cursor
string

Return the page of entries after this one.

limit
integer

Limit the size of the list that is returned. The default (and maximum) is 100 objects.

account_id
string

Filter Check Transfers to those that originated from the specified Account.

idempotency_key
string

Filter records to the one with the specified idempotency_key you chose for that object. This value is unique across Increase and is used to ensure that a request is only processed once. Learn more about idempotency.

200 character maximum
status.in
array of strings

Filter Check Transfers to those that have the specified status. For GET requests, this should be encoded as a comma-delimited string, such as ?in=one,two,three.

created_at.after
string

Return results after this ISO 8601 timestamp.

created_at.before
string

Return results before this ISO 8601 timestamp.

created_at.on_or_after
string

Return results on or after this ISO 8601 timestamp.

created_at.on_or_before
string

Return results on or before this ISO 8601 timestamp.

Create a Check Transfer
curl -X "POST" \
  --url "${INCREASE_URL}/check_transfers" \
  -H "Authorization: Bearer ${INCREASE_API_KEY}" \
  -H "Content-Type: application/json" \
  -d $'{
    "account_id": "account_in71c4amph0vgo2qllky",
    "amount": 1000,
    "fulfillment_method": "physical_check",
    "physical_check": {
      "mailing_address": {
        "city": "New York",
        "line1": "33 Liberty Street",
        "name": "Ian Crease",
        "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"
  }'
Parameters
account_id
string
Required

The identifier for the account that will send the transfer.

amount
integer
Required

The transfer amount in USD cents.

check_number
string

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.

10 character maximum
fulfillment_method
enum
Required

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

physical_check
dictionary

Details relating to the physical check that Increase will print and mail. This is required if fulfillment_method is equal to physical_check. It must not be included if any other fulfillment_method is provided.

require_approval
boolean

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

source_account_number_id
string
Required

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

third_party
dictionary

Details relating to the custom fulfillment you will perform. This is required if fulfillment_method is equal to third_party. It must not be included if any other fulfillment_method is provided.

Retrieve a Check Transfer
curl \
  --url "${INCREASE_URL}/check_transfers/check_transfer_30b43acfu9vw8fyc4f5" \
  -H "Authorization: Bearer ${INCREASE_API_KEY}"
Parameters
check_transfer_id
string
Required

The identifier of the Check Transfer.

Approve a Check Transfer
curl -X "POST" \
  --url "${INCREASE_URL}/check_transfers/check_transfer_30b43acfu9vw8fyc4f5/approve" \
  -H "Authorization: Bearer ${INCREASE_API_KEY}"
Parameters
check_transfer_id
string
Required

The identifier of the Check Transfer to approve.

Cancel a pending Check Transfer
curl -X "POST" \
  --url "${INCREASE_URL}/check_transfers/check_transfer_30b43acfu9vw8fyc4f5/cancel" \
  -H "Authorization: Bearer ${INCREASE_API_KEY}"
Parameters
check_transfer_id
string
Required

The identifier of the pending Check Transfer to cancel.

Stop payment on a Check Transfer
curl -X "POST" \
  --url "${INCREASE_URL}/check_transfers/check_transfer_30b43acfu9vw8fyc4f5/stop_payment" \
  -H "Authorization: Bearer ${INCREASE_API_KEY}" \
  -H "Content-Type: application/json" \
  -d $'{
    "reason": "mail_delivery_failed"
  }'
Parameters
check_transfer_id
string
Required

The identifier of the Check Transfer.

reason
enum

The reason why this transfer should be stopped.

Sandbox: Mail a Check Transfer

Simulates the mailing of a Check Transfer, which happens periodically throughout the day in production but can be sped up in sandbox. This transfer must first have a status of pending_approval or pending_submission.

curl -X "POST" \
  --url "${INCREASE_URL}/simulations/check_transfers/check_transfer_30b43acfu9vw8fyc4f5/mail" \
  -H "Authorization: Bearer ${INCREASE_API_KEY}"
Parameters
check_transfer_id
string
Required

The identifier of the Check Transfer you wish to mail.