increase-test
POST/check_transfers/{check_transfer_id}/approve

Approve a check transfer

Approves a check transfer that is awaiting approval. Use check_transfer_id to identify the transfer to approve. The response contains the check transfer object with its current approval details.

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

1 parameter
check_transfer_idstringrequired
The identifier of the check transfer to approve.

3 status codes
200Returns the 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

The check_transfer_id path parameter must identify the check transfer to approve.