increase-test
POST/check_transfers

Create a check transfer

Creates a check transfer to send funds from an account by mailing a physical check or using third-party fulfillment. Provide the source account, amount, and fulfillment method, along with the required check details. The physical_check or third_party object must match the selected fulfillment_method.

  • IdempotentThe SDK sends Idempotency-Key, so a retried request is only applied once.

10 body fields

Check transfer details, including the source account, amount, fulfillment method, and the check information required for the selected fulfillment method.

account_idstringrequired
The identifier for the account that will send the transfer.
amountintegerrequired
The transfer amount in USD cents.
balance_checkstringoptional
How the account's available balance should be checked. If omitted, the default behavior is `balance_check: full`.
Allowed:fullnone
check_numberstringoptional
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_methodstringrequired
Whether Increase will print and mail the check or if you will do it yourself.
Allowed:physical_checkthird_party
physical_checkobjectoptional
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_approvalbooleanoptional
Whether the transfer requires explicit approval via the dashboard or API.
source_account_number_idstringrequired
The identifier of the Account Number from which to send the transfer and print on the check.
third_partyobjectoptional
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.
valid_until_datestringoptional
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 expiration.

3 status codes
200Returns the created check transfer object, including its identifier, account and source account number, amount, check details, fulfillment method, creation time, currency, and approval information.
account_idstringrequired
The identifier of the Account from which funds will be transferred.
account_numberstringrequired
The account number printed on the check.
amountintegerrequired
The transfer amount in USD cents.
approvalobjectrequired
If your account requires approvals for transfers and the transfer was approved, this will contain details of the approval.
approved_inbound_check_deposit_idstringrequired
If the Check Transfer was successfully deposited, this will contain the identifier of the Inbound Check Deposit object with details of the deposit. The Inbound Check Deposit object will have information about any associated Transactions for this Check Transfer.
balance_checkstringrequired
How the account's available balance should be checked.
Allowed:fullnone
cancellationobjectrequired
If your account requires approvals for transfers and the transfer was not approved, this will contain details of the cancellation.
check_numberstringrequired
The check number printed on the check.
created_atstringrequired
The [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) date and time at which the transfer was created.
created_byobjectrequired
What object created the transfer, either via the API or the dashboard.
currencystringrequired
The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the check's currency.
Allowed:USD
fulfillment_methodstringrequired
Whether Increase will print and mail the check or if you will do it yourself.
Allowed:physical_checkthird_party
idstringrequired
The Check transfer's identifier.
idempotency_keystringrequired
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](https://increase.com/documentation/idempotency-keys).
mailingobjectrequired
If the check has been mailed by Increase, this will contain details of the shipment.
pending_transaction_idstringrequired
The ID for the pending transaction representing the transfer. A pending transaction is created when the transfer [requires approval](https://increase.com/documentation/transfer-approvals#transfer-approvals) by someone else in your organization.
physical_checkobjectrequired
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_numberstringrequired
The routing number printed on the check.
source_account_number_idstringrequired
The identifier of the Account Number from which to send the transfer and print on the check.
statusstringrequired
The lifecycle status of the transfer.
Allowed:pending_approvalcanceledpending_batch_completingpending_submissionpending_reviewingrequires_attentionrejectedpending_mailingmaileddepositedstoppedreturned
stop_payment_requestobjectrequired
After a stop-payment is requested on the check, this will contain supplemental details.
submissionobjectrequired
After the transfer is submitted, this will contain supplemental details.
third_partyobjectrequired
Details relating to the custom fulfillment you will perform. Will be present if and only if `fulfillment_method` is equal to `third_party`.
typestringrequired
A constant representing the object's type. For this resource it will always be `check_transfer`.
Allowed:check_transfer
valid_until_datestringrequired
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 expiration.
4XXReturned when the request fails with a client error.
5XXReturned when the request fails with a server error.

Error handling

account_id, source_account_number_id, fulfillment_method, and amount are required, and amount must be at least 1 USD cent. fulfillment_method must be physical_check or third_party; provide only the corresponding object, and include the required fields for that fulfillment method. The required physical check fields include memo, recipient_name, payer, and mailing_address.