Need help with your APIs? I offer API discovery, governance & evangelism services. Explore services →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Increase Check Transfers API

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

Increase Check Transfers API is one of 56 APIs that Increase publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include Check Transfers. The published artifact set on APIs.io includes an OpenAPI specification and API documentation.

This API exposes 6 operations across 5 paths, and defines 6 schemas. It is described by OpenAPI 3.1.0, at version 0.0.1.

Requests are made against 2 base URLs: https://api.increase.com, https://sandbox.increase.com.

6 operations 5 paths 6 schemas 2 GET4 POST

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.1.0
API Version
0.0.1
Base URL
https://api.increase.com
Authentication
HTTP Bearer
Resource Areas
1

Authentication & Security 1

Increase Check Transfers API declares 1 security scheme for authenticating requests. It accepts HTTP bearer tokens (bearerAuth). By default, every request must be authenticated.

Paths & Operations 6

Across 5 paths, the API surfaces 6 operations — 2 GET, 4 POST. Each is listed below with its method, path, parameters, and response codes.

Check Transfers 6

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

GET
/check_transfers
List Check Transfers
list_check_transfers 9 params → 2004XX5XX
POST
/check_transfers
Create a Check Transfer
create_a_check_transfer body → 2004XX5XX
GET
/check_transfers/{check_transfer_id}
Retrieve a Check Transfer
retrieve_a_check_transfer 1 param → 2004XX5XX
POST
/check_transfers/{check_transfer_id}/approve
Approve a Check Transfer
approve_a_check_transfer 1 param → 2004XX5XX
POST
/check_transfers/{check_transfer_id}/cancel
Cancel a pending Check Transfer
cancel_a_pending_check_transfer 1 param → 2004XX5XX
POST
/check_transfers/{check_transfer_id}/stop_payment
Stop payment on a Check Transfer
stop_payment_on_a_check_transfer 1 param body → 2004XX5XX

Schemas 6

The contract defines 6 schemas that model the data the API accepts and returns. The most detailed are check_transfer (25 properties), create_a_check_transfer_parameters (10 properties), check_transfer_stop_payment_request (4 properties), check_transfer_list (2 properties). Each schema is shown below with its type and property counts.

stop_payment_on_a_check_transfer_parameters
object
1 property
error
check_transfer_list
object
A list of Check Transfer objects.
2 properties 2 required
create_a_check_transfer_parameters
object
10 properties 4 required
check_transfer
object
Check Transfers move funds from your Increase account by mailing a physical check.
25 properties 25 required
check_transfer_stop_payment_request
object
A Check Transfer Stop Payment Request is created when a check transfer is stopped. It offsets the Check Transfer Intention.
4 properties 4 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

increase-check-transfers-api-openapi.yml Raw ↑

Other APIs Increase publishes across the network.

Increase Account Numbers API
Increase Account Statements API
Increase Account Transfers API
Increase Accounts API
Increase Ach Prenotifications API
Increase Ach Transfers API
Increase Card Disputes API
Increase Card Payments API
Increase Card Purchase Supplements API
Increase Card Push Transfers API
Increase Card Tokens API
Increase Card Validations API