Check Deposits

Check Deposits allow you to deposit images of paper checks into your account.

Events

Your application can listen to webhooks about this resource. The events about Check Deposits will have the categories "check_deposit.created" or "check_deposit.updated" .

The Check Deposit object

{
  "account_id": "account_in71c4amph0vgo2qllky",
  "amount": 1000,
  "back_image_file_id": "file_26khfk98mzfz90a11oqx",
  "created_at": "2020-01-31T23:59:59Z",
  "deposit_acceptance": {
    "account_number": "987654321",
    "amount": 1000,
    "auxiliary_on_us": "101",
    "check_deposit_id": "check_deposit_f06n9gpg7sxn8t19lfc1",
    "currency": "USD",
    "routing_number": "101050001",
    "serial_number": null
  },
  "deposit_adjustments": [],
  "deposit_rejection": null,
  "deposit_return": null,
  "deposit_submission": {
    "back_file_id": "file_frhw4s443nh7noss55kq",
    "front_file_id": "file_j7ed9mrve741m6yui9ju",
    "submitted_at": "2020-02-01T00:59:59+00:00"
  },
  "description": null,
  "front_image_file_id": "file_makxrc67oh9l6sg7w9yc",
  "id": "check_deposit_f06n9gpg7sxn8t19lfc1",
  "idempotency_key": null,
  "inbound_funds_hold": null,
  "inbound_mail_item_id": null,
  "lockbox_recipient_id": null,
  "status": "submitted",
  "transaction_id": "transaction_uyrp7fld2ium70oa7oi",
  "type": "check_deposit"
}

Attributes

account_id

string

The Account the check was deposited into.

More about Accounts.

amount

integer

The deposited amount in USD cents.

back_image_file_id

string

Nullable

The ID for the File containing the image of the back of the check.

More about Files.

created_at

string

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

deposit_acceptance

dictionary

Nullable

Once your deposit is successfully parsed and accepted by Increase, this will contain details of the parsed check.

deposit_adjustments

array

If the deposit or the return was adjusted by the receiving institution, this will contain details of the adjustments.

deposit_rejection

dictionary

Nullable

If your deposit is rejected by Increase, this will contain details as to why it was rejected.

deposit_return

dictionary

Nullable

If your deposit is returned, this will contain details as to why it was returned.

deposit_submission

dictionary

Nullable

After the check is parsed, it is submitted to the Check21 network for processing. This will contain details of the submission.

description

string

Nullable

The description of the Check Deposit, for display purposes only.

front_image_file_id

string

The ID for the File containing the image of the front of the check.

More about Files.

string

The deposit’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.

inbound_funds_hold

dictionary

Nullable

Increase will sometimes hold the funds for Check Deposits. If funds are held, this sub-object will contain details of the hold.

inbound_mail_item_id

string

Nullable

If the Check Deposit was the result of an Inbound Mail Item, this will contain the identifier of the Inbound Mail Item.

More about Inbound Mail Items.

lockbox_recipient_id

string

Nullable

If the Check Deposit was the result of an Inbound Mail Item routed to a Lockbox Recipient, this will contain the identifier of the Lockbox Recipient that received it.

More about Lockbox Recipients.

status

enum

The status of the Check Deposit.

transaction_id

string

Nullable

The ID for the Transaction created by the deposit.

More about Transactions.

type

string

A constant representing the object’s type. For this resource it will always be check_deposit.

List Check Deposits

curl \
  --url "${INCREASE_URL}/check_deposits?account_id=account_in71c4amph0vgo2qllky" \
  -H "Authorization: Bearer ${INCREASE_API_KEY}"

import Increase from 'increase';

const client = new Increase({
  apiKey: process.env['INCREASE_API_KEY'], // This is the default and can be omitted
});

// Automatically fetches more pages as needed.
for await (const checkDeposit of client.checkDeposits.list()) {
  console.log(checkDeposit.id);
}

import os
from increase import Increase

client = Increase(
    api_key=os.environ.get("INCREASE_API_KEY"),  # This is the default and can be omitted
)
page = client.check_deposits.list()
page = page.data[0]
print(page.id)

require "increase"

increase = Increase::Client.new(
  api_key: ENV["INCREASE_API_KEY"] # This is the default and can be omitted
)

page = increase.check_deposits.list

puts(page)

package main

import (
	"context"
	"fmt"
	"os"

	"github.com/Increase/increase-go"
	"github.com/Increase/increase-go/option"
)

func main() {
	client := increase.NewClient(
		option.WithAPIKey(os.Getenv("INCREASE_API_KEY")), // This is the default and can be omitted
	)
	page, err := client.CheckDeposits.List(context.TODO(), increase.CheckDepositListParams{})
	if err != nil {
		panic(err.Error())
	}
	fmt.Printf("%+v\n", page)
}

package com.increase.api.example;

import com.increase.api.client.IncreaseClient;
import com.increase.api.client.okhttp.IncreaseOkHttpClient;
import com.increase.api.models.checkdeposits.CheckDepositListPage;
import com.increase.api.models.checkdeposits.CheckDepositListParams;

public final class Main {
    private Main() {}

    public static void main(String[] args) {
        IncreaseClient client = IncreaseOkHttpClient.fromEnv();

        CheckDepositListPage page = client.checkDeposits().list();
    }
}

package com.increase.api.example

import com.increase.api.client.IncreaseClient
import com.increase.api.client.okhttp.IncreaseOkHttpClient
import com.increase.api.models.checkdeposits.CheckDepositListPage
import com.increase.api.models.checkdeposits.CheckDepositListParams

fun main() {
    val client: IncreaseClient = IncreaseOkHttpClient.fromEnv()

    val page: CheckDepositListPage = client.checkDeposits().list()
}

<?php

require_once dirname(__DIR__) . '/vendor/autoload.php';

use Increase\Client;
use Increase\Core\Exceptions\APIException;

$client = new Client(apiKey: getenv('INCREASE_API_KEY'));

try {
  $page = $client->checkDeposits->list(
    accountID: 'account_id',
    createdAt: [
      'after' => new \DateTimeImmutable('2019-12-27T18:11:19.117Z'),
      'before' => new \DateTimeImmutable('2019-12-27T18:11:19.117Z'),
      'onOrAfter' => new \DateTimeImmutable('2019-12-27T18:11:19.117Z'),
      'onOrBefore' => new \DateTimeImmutable('2019-12-27T18:11:19.117Z'),
    ],
    cursor: 'cursor',
    idempotencyKey: 'x',
    limit: 1,
  );

  var_dump($page);
} catch (APIException $e) {
  echo $e->getMessage();
}

using System;
using Increase.Api;
using Increase.Api.Models.CheckDeposits;

IncreaseClient client = new();

CheckDepositListParams parameters = new();

var page = await client.CheckDeposits.List(parameters);
await foreach (var item in page.Paginate())
{
    Console.WriteLine(item);
}

Returns a list response :

{
  "data": [
    { /* Check Deposit object */ },
    { /* Check Deposit object */ }
    /* ... */
  ],
  "next_cursor": "v57w5d",
}

Parameters

account_id

string

Filter Check Deposits to those belonging to the specified Account.

More about Accounts.

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.

Between 1 and 200 characters

cursor

string

limit

integer

created_at.after

string

created_at.before

string

created_at.on_or_after

string

created_at.on_or_before

string

Create a Check Deposit

curl -X "POST" \
  --url "${INCREASE_URL}/check_deposits" \
  -H "Authorization: Bearer ${INCREASE_API_KEY}" \
  -H "Content-Type: application/json" \
  -d $'{
    "account_id": "account_in71c4amph0vgo2qllky",
    "amount": 1000,
    "back_image_file_id": "file_26khfk98mzfz90a11oqx",
    "description": "Vendor payment",
    "front_image_file_id": "file_hkv175ovmc2tb2v2zbrm"
  }'

import Increase from 'increase';

const client = new Increase({
  apiKey: process.env['INCREASE_API_KEY'], // This is the default and can be omitted
});

const checkDeposit = await client.checkDeposits.create({
  account_id: 'account_in71c4amph0vgo2qllky',
  amount: 1000,
  back_image_file_id: 'file_26khfk98mzfz90a11oqx',
  front_image_file_id: 'file_hkv175ovmc2tb2v2zbrm',
});

console.log(checkDeposit.id);

import os
from increase import Increase

client = Increase(
    api_key=os.environ.get("INCREASE_API_KEY"),  # This is the default and can be omitted
)
check_deposit = client.check_deposits.create(
    account_id="account_in71c4amph0vgo2qllky",
    amount=1000,
    back_image_file_id="file_26khfk98mzfz90a11oqx",
    front_image_file_id="file_hkv175ovmc2tb2v2zbrm",
)
print(check_deposit.id)

require "increase"

increase = Increase::Client.new(
  api_key: ENV["INCREASE_API_KEY"] # This is the default and can be omitted
)

check_deposit = increase.check_deposits.create(
  account_id: "account_in71c4amph0vgo2qllky",
  amount: 1000,
  back_image_file_id: "file_26khfk98mzfz90a11oqx",
  front_image_file_id: "file_hkv175ovmc2tb2v2zbrm"
)

puts(check_deposit)

package main

import (
	"context"
	"fmt"
	"os"

	"github.com/Increase/increase-go"
	"github.com/Increase/increase-go/option"
)

func main() {
	client := increase.NewClient(
		option.WithAPIKey(os.Getenv("INCREASE_API_KEY")), // This is the default and can be omitted
	)
	checkDeposit, err := client.CheckDeposits.New(context.TODO(), increase.CheckDepositNewParams{
		AccountID:        increase.F("account_in71c4amph0vgo2qllky"),
		Amount:           increase.F(int64(1000)),
		BackImageFileID:  increase.F("file_26khfk98mzfz90a11oqx"),
		FrontImageFileID: increase.F("file_hkv175ovmc2tb2v2zbrm"),
	})
	if err != nil {
		panic(err.Error())
	}
	fmt.Printf("%+v\n", checkDeposit.ID)
}

package com.increase.api.example;

import com.increase.api.client.IncreaseClient;
import com.increase.api.client.okhttp.IncreaseOkHttpClient;
import com.increase.api.models.checkdeposits.CheckDeposit;
import com.increase.api.models.checkdeposits.CheckDepositCreateParams;

public final class Main {
    private Main() {}

    public static void main(String[] args) {
        IncreaseClient client = IncreaseOkHttpClient.fromEnv();

        CheckDepositCreateParams params = CheckDepositCreateParams.builder()
            .accountId("account_in71c4amph0vgo2qllky")
            .amount(1000L)
            .backImageFileId("file_26khfk98mzfz90a11oqx")
            .frontImageFileId("file_hkv175ovmc2tb2v2zbrm")
            .build();
        CheckDeposit checkDeposit = client.checkDeposits().create(params);
    }
}

package com.increase.api.example

import com.increase.api.client.IncreaseClient
import com.increase.api.client.okhttp.IncreaseOkHttpClient
import com.increase.api.models.checkdeposits.CheckDeposit
import com.increase.api.models.checkdeposits.CheckDepositCreateParams

fun main() {
    val client: IncreaseClient = IncreaseOkHttpClient.fromEnv()

    val params: CheckDepositCreateParams = CheckDepositCreateParams.builder()
        .accountId("account_in71c4amph0vgo2qllky")
        .amount(1000L)
        .backImageFileId("file_26khfk98mzfz90a11oqx")
        .frontImageFileId("file_hkv175ovmc2tb2v2zbrm")
        .build()
    val checkDeposit: CheckDeposit = client.checkDeposits().create(params)
}

<?php

require_once dirname(__DIR__) . '/vendor/autoload.php';

use Increase\Client;
use Increase\Core\Exceptions\APIException;

$client = new Client(apiKey: getenv('INCREASE_API_KEY'));

try {
  $checkDeposit = $client->checkDeposits->create(
    accountID: 'account_in71c4amph0vgo2qllky',
    amount: 1000,
    backImageFileID: 'file_26khfk98mzfz90a11oqx',
    frontImageFileID: 'file_hkv175ovmc2tb2v2zbrm',
    description: 'Vendor payment',
  );

  var_dump($checkDeposit);
} catch (APIException $e) {
  echo $e->getMessage();
}

using System;
using Increase.Api;
using Increase.Api.Models.CheckDeposits;

IncreaseClient client = new();

CheckDepositCreateParams parameters = new()
{
    AccountID = "account_in71c4amph0vgo2qllky",
    Amount = 1000,
    BackImageFileID = "file_26khfk98mzfz90a11oqx",
    FrontImageFileID = "file_hkv175ovmc2tb2v2zbrm",
};

var checkDeposit = await client.CheckDeposits.Create(parameters);

Console.WriteLine(checkDeposit);

Parameters

account_id

string

Required

The identifier for the Account to deposit the check in.

More about Accounts.

amount

integer

Required

The deposit amount in USD cents.

back_image_file_id

string

Required

The File containing the check’s back image.

More about Files.

description

string

The description you choose to give the Check Deposit, for display purposes only.

Between 1 and 200 characters

front_image_file_id

string

Required

The File containing the check’s front image.

More about Files.

Retrieve a Check Deposit

curl \
  --url "${INCREASE_URL}/check_deposits/check_deposit_f06n9gpg7sxn8t19lfc1" \
  -H "Authorization: Bearer ${INCREASE_API_KEY}"

import Increase from 'increase';

const client = new Increase({
  apiKey: process.env['INCREASE_API_KEY'], // This is the default and can be omitted
});

const checkDeposit = await client.checkDeposits.retrieve('check_deposit_f06n9gpg7sxn8t19lfc1');

console.log(checkDeposit.id);

import os
from increase import Increase

client = Increase(
    api_key=os.environ.get("INCREASE_API_KEY"),  # This is the default and can be omitted
)
check_deposit = client.check_deposits.retrieve(
    "check_deposit_f06n9gpg7sxn8t19lfc1",
)
print(check_deposit.id)

require "increase"

increase = Increase::Client.new(
  api_key: ENV["INCREASE_API_KEY"] # This is the default and can be omitted
)

check_deposit = increase.check_deposits.retrieve("check_deposit_f06n9gpg7sxn8t19lfc1")

puts(check_deposit)

package main

import (
	"context"
	"fmt"
	"os"

	"github.com/Increase/increase-go"
	"github.com/Increase/increase-go/option"
)

func main() {
	client := increase.NewClient(
		option.WithAPIKey(os.Getenv("INCREASE_API_KEY")), // This is the default and can be omitted
	)
	checkDeposit, err := client.CheckDeposits.Get(context.TODO(), "check_deposit_f06n9gpg7sxn8t19lfc1")
	if err != nil {
		panic(err.Error())
	}
	fmt.Printf("%+v\n", checkDeposit.ID)
}

package com.increase.api.example;

import com.increase.api.client.IncreaseClient;
import com.increase.api.client.okhttp.IncreaseOkHttpClient;
import com.increase.api.models.checkdeposits.CheckDeposit;
import com.increase.api.models.checkdeposits.CheckDepositRetrieveParams;

public final class Main {
    private Main() {}

    public static void main(String[] args) {
        IncreaseClient client = IncreaseOkHttpClient.fromEnv();

        CheckDeposit checkDeposit = client.checkDeposits().retrieve("check_deposit_f06n9gpg7sxn8t19lfc1");
    }
}

package com.increase.api.example

import com.increase.api.client.IncreaseClient
import com.increase.api.client.okhttp.IncreaseOkHttpClient
import com.increase.api.models.checkdeposits.CheckDeposit
import com.increase.api.models.checkdeposits.CheckDepositRetrieveParams

fun main() {
    val client: IncreaseClient = IncreaseOkHttpClient.fromEnv()

    val checkDeposit: CheckDeposit = client.checkDeposits().retrieve("check_deposit_f06n9gpg7sxn8t19lfc1")
}

<?php

require_once dirname(__DIR__) . '/vendor/autoload.php';

use Increase\Client;
use Increase\Core\Exceptions\APIException;

$client = new Client(apiKey: getenv('INCREASE_API_KEY'));

try {
  $checkDeposit = $client->checkDeposits->retrieve(
    'check_deposit_f06n9gpg7sxn8t19lfc1'
  );

  var_dump($checkDeposit);
} catch (APIException $e) {
  echo $e->getMessage();
}

using System;
using Increase.Api;
using Increase.Api.Models.CheckDeposits;

IncreaseClient client = new();

CheckDepositRetrieveParams parameters = new()
{
    CheckDepositID = "check_deposit_f06n9gpg7sxn8t19lfc1"
};

var checkDeposit = await client.CheckDeposits.Retrieve(parameters);

Console.WriteLine(checkDeposit);

Parameters

check_deposit_id

string

Required

The identifier of the Check Deposit to retrieve.

More about Check Deposits.

Sandbox: Adjust a Check Deposit

Simulates the creation of a Check Deposit Adjustment on a Check Deposit. This Check Deposit must first have a status of submitted.

curl -X "POST" \
  --url "${INCREASE_URL}/simulations/check_deposits/check_deposit_f06n9gpg7sxn8t19lfc1/adjustment" \
  -H "Authorization: Bearer ${INCREASE_API_KEY}" \
  -H "Content-Type: application/json" \
  -d $'{}'

import Increase from 'increase';

const client = new Increase({
  apiKey: process.env['INCREASE_API_KEY'], // This is the default and can be omitted
});

const checkDeposit = await client.simulations.checkDeposits.adjustment(
  'check_deposit_f06n9gpg7sxn8t19lfc1',
);

console.log(checkDeposit.id);

import os
from increase import Increase

client = Increase(
    api_key=os.environ.get("INCREASE_API_KEY"),  # This is the default and can be omitted
)
check_deposit = client.simulations.check_deposits.adjustment(
    check_deposit_id="check_deposit_f06n9gpg7sxn8t19lfc1",
)
print(check_deposit.id)

require "increase"

increase = Increase::Client.new(
  api_key: ENV["INCREASE_API_KEY"] # This is the default and can be omitted
)

check_deposit = increase.simulations.check_deposits.adjustment("check_deposit_f06n9gpg7sxn8t19lfc1")

puts(check_deposit)

package main

import (
	"context"
	"fmt"
	"os"

	"github.com/Increase/increase-go"
	"github.com/Increase/increase-go/option"
)

func main() {
	client := increase.NewClient(
		option.WithAPIKey(os.Getenv("INCREASE_API_KEY")), // This is the default and can be omitted
	)
	checkDeposit, err := client.Simulations.CheckDeposits.Adjustment(
		context.TODO(),
		"check_deposit_f06n9gpg7sxn8t19lfc1",
		increase.SimulationCheckDepositAdjustmentParams{},
	)
	if err != nil {
		panic(err.Error())
	}
	fmt.Printf("%+v\n", checkDeposit.ID)
}

package com.increase.api.example;

import com.increase.api.client.IncreaseClient;
import com.increase.api.client.okhttp.IncreaseOkHttpClient;
import com.increase.api.models.checkdeposits.CheckDeposit;
import com.increase.api.models.simulations.checkdeposits.CheckDepositAdjustmentParams;

public final class Main {
    private Main() {}

    public static void main(String[] args) {
        IncreaseClient client = IncreaseOkHttpClient.fromEnv();

        CheckDeposit checkDeposit = client.simulations().checkDeposits().adjustment("check_deposit_f06n9gpg7sxn8t19lfc1");
    }
}

package com.increase.api.example

import com.increase.api.client.IncreaseClient
import com.increase.api.client.okhttp.IncreaseOkHttpClient
import com.increase.api.models.checkdeposits.CheckDeposit
import com.increase.api.models.simulations.checkdeposits.CheckDepositAdjustmentParams

fun main() {
    val client: IncreaseClient = IncreaseOkHttpClient.fromEnv()

    val checkDeposit: CheckDeposit = client.simulations().checkDeposits().adjustment("check_deposit_f06n9gpg7sxn8t19lfc1")
}

<?php

require_once dirname(__DIR__) . '/vendor/autoload.php';

use Increase\Client;
use Increase\Core\Exceptions\APIException;

$client = new Client(apiKey: getenv('INCREASE_API_KEY'));

try {
  $checkDeposit = $client->simulations->checkDeposits->adjustment(
    'check_deposit_f06n9gpg7sxn8t19lfc1',
    amount: -1000000000,
    reason: 'late_return',
  );

  var_dump($checkDeposit);
} catch (APIException $e) {
  echo $e->getMessage();
}

using System;
using Increase.Api;
using Increase.Api.Models.Simulations.CheckDeposits;

IncreaseClient client = new();

CheckDepositAdjustmentParams parameters = new()
{
    CheckDepositID = "check_deposit_f06n9gpg7sxn8t19lfc1"
};

var checkDeposit = await client.Simulations.CheckDeposits.Adjustment(parameters);

Console.WriteLine(checkDeposit);

Parameters

check_deposit_id

string

Required

The identifier of the Check Deposit you wish to adjust.

More about Check Deposits.

amount

integer

The adjustment amount in the minor unit of the Check Deposit’s currency (e.g., cents). A negative amount means that the funds are being clawed back by the other bank and is a debit to your account. Defaults to the negative of the Check Deposit amount.

reason

enum

The reason for the adjustment. Defaults to non_conforming_item, which is often used for a low quality image that the recipient wasn’t able to handle.

Sandbox: Reject a Check Deposit

Simulates the rejection of a Check Deposit by Increase due to factors like poor image quality. This Check Deposit must first have a status of pending.

curl -X "POST" \
  --url "${INCREASE_URL}/simulations/check_deposits/check_deposit_f06n9gpg7sxn8t19lfc1/reject" \
  -H "Authorization: Bearer ${INCREASE_API_KEY}"

import Increase from 'increase';

const client = new Increase({
  apiKey: process.env['INCREASE_API_KEY'], // This is the default and can be omitted
});

const checkDeposit = await client.simulations.checkDeposits.reject(
  'check_deposit_f06n9gpg7sxn8t19lfc1',
);

console.log(checkDeposit.id);

import os
from increase import Increase

client = Increase(
    api_key=os.environ.get("INCREASE_API_KEY"),  # This is the default and can be omitted
)
check_deposit = client.simulations.check_deposits.reject(
    "check_deposit_f06n9gpg7sxn8t19lfc1",
)
print(check_deposit.id)

require "increase"

increase = Increase::Client.new(
  api_key: ENV["INCREASE_API_KEY"] # This is the default and can be omitted
)

check_deposit = increase.simulations.check_deposits.reject("check_deposit_f06n9gpg7sxn8t19lfc1")

puts(check_deposit)

package main

import (
	"context"
	"fmt"
	"os"

	"github.com/Increase/increase-go"
	"github.com/Increase/increase-go/option"
)

func main() {
	client := increase.NewClient(
		option.WithAPIKey(os.Getenv("INCREASE_API_KEY")), // This is the default and can be omitted
	)
	checkDeposit, err := client.Simulations.CheckDeposits.Reject(context.TODO(), "check_deposit_f06n9gpg7sxn8t19lfc1")
	if err != nil {
		panic(err.Error())
	}
	fmt.Printf("%+v\n", checkDeposit.ID)
}

package com.increase.api.example;

import com.increase.api.client.IncreaseClient;
import com.increase.api.client.okhttp.IncreaseOkHttpClient;
import com.increase.api.models.checkdeposits.CheckDeposit;
import com.increase.api.models.simulations.checkdeposits.CheckDepositRejectParams;

public final class Main {
    private Main() {}

    public static void main(String[] args) {
        IncreaseClient client = IncreaseOkHttpClient.fromEnv();

        CheckDeposit checkDeposit = client.simulations().checkDeposits().reject("check_deposit_f06n9gpg7sxn8t19lfc1");
    }
}

package com.increase.api.example

import com.increase.api.client.IncreaseClient
import com.increase.api.client.okhttp.IncreaseOkHttpClient
import com.increase.api.models.checkdeposits.CheckDeposit
import com.increase.api.models.simulations.checkdeposits.CheckDepositRejectParams

fun main() {
    val client: IncreaseClient = IncreaseOkHttpClient.fromEnv()

    val checkDeposit: CheckDeposit = client.simulations().checkDeposits().reject("check_deposit_f06n9gpg7sxn8t19lfc1")
}

<?php

require_once dirname(__DIR__) . '/vendor/autoload.php';

use Increase\Client;
use Increase\Core\Exceptions\APIException;

$client = new Client(apiKey: getenv('INCREASE_API_KEY'));

try {
  $checkDeposit = $client->simulations->checkDeposits->reject(
    'check_deposit_f06n9gpg7sxn8t19lfc1'
  );

  var_dump($checkDeposit);
} catch (APIException $e) {
  echo $e->getMessage();
}

using System;
using Increase.Api;
using Increase.Api.Models.Simulations.CheckDeposits;

IncreaseClient client = new();

CheckDepositRejectParams parameters = new()
{
    CheckDepositID = "check_deposit_f06n9gpg7sxn8t19lfc1"
};

var checkDeposit = await client.Simulations.CheckDeposits.Reject(parameters);

Console.WriteLine(checkDeposit);

Parameters

check_deposit_id

string

Required

The identifier of the Check Deposit you wish to reject.

More about Check Deposits.

Sandbox: Return a Check Deposit

Simulates the return of a Check Deposit. This Check Deposit must first have a status of submitted.

curl -X "POST" \
  --url "${INCREASE_URL}/simulations/check_deposits/check_deposit_f06n9gpg7sxn8t19lfc1/return" \
  -H "Authorization: Bearer ${INCREASE_API_KEY}"

import Increase from 'increase';

const client = new Increase({
  apiKey: process.env['INCREASE_API_KEY'], // This is the default and can be omitted
});

const checkDeposit = await client.simulations.checkDeposits.return(
  'check_deposit_f06n9gpg7sxn8t19lfc1',
);

console.log(checkDeposit.id);

import os
from increase import Increase

client = Increase(
    api_key=os.environ.get("INCREASE_API_KEY"),  # This is the default and can be omitted
)
check_deposit = client.simulations.check_deposits.return_(
    "check_deposit_f06n9gpg7sxn8t19lfc1",
)
print(check_deposit.id)

require "increase"

increase = Increase::Client.new(
  api_key: ENV["INCREASE_API_KEY"] # This is the default and can be omitted
)

check_deposit = increase.simulations.check_deposits.return_("check_deposit_f06n9gpg7sxn8t19lfc1")

puts(check_deposit)

package main

import (
	"context"
	"fmt"
	"os"

	"github.com/Increase/increase-go"
	"github.com/Increase/increase-go/option"
)

func main() {
	client := increase.NewClient(
		option.WithAPIKey(os.Getenv("INCREASE_API_KEY")), // This is the default and can be omitted
	)
	checkDeposit, err := client.Simulations.CheckDeposits.Return(context.TODO(), "check_deposit_f06n9gpg7sxn8t19lfc1")
	if err != nil {
		panic(err.Error())
	}
	fmt.Printf("%+v\n", checkDeposit.ID)
}

package com.increase.api.example;

import com.increase.api.client.IncreaseClient;
import com.increase.api.client.okhttp.IncreaseOkHttpClient;
import com.increase.api.models.checkdeposits.CheckDeposit;
import com.increase.api.models.simulations.checkdeposits.CheckDepositReturnParams;

public final class Main {
    private Main() {}

    public static void main(String[] args) {
        IncreaseClient client = IncreaseOkHttpClient.fromEnv();

        CheckDeposit checkDeposit = client.simulations().checkDeposits().return_("check_deposit_f06n9gpg7sxn8t19lfc1");
    }
}

package com.increase.api.example

import com.increase.api.client.IncreaseClient
import com.increase.api.client.okhttp.IncreaseOkHttpClient
import com.increase.api.models.checkdeposits.CheckDeposit
import com.increase.api.models.simulations.checkdeposits.CheckDepositReturnParams

fun main() {
    val client: IncreaseClient = IncreaseOkHttpClient.fromEnv()

    val checkDeposit: CheckDeposit = client.simulations().checkDeposits().return_("check_deposit_f06n9gpg7sxn8t19lfc1")
}

<?php

require_once dirname(__DIR__) . '/vendor/autoload.php';

use Increase\Client;
use Increase\Core\Exceptions\APIException;

$client = new Client(apiKey: getenv('INCREASE_API_KEY'));

try {
  $checkDeposit = $client->simulations->checkDeposits->return(
    'check_deposit_f06n9gpg7sxn8t19lfc1'
  );

  var_dump($checkDeposit);
} catch (APIException $e) {
  echo $e->getMessage();
}

using System;
using Increase.Api;
using Increase.Api.Models.Simulations.CheckDeposits;

IncreaseClient client = new();

CheckDepositReturnParams parameters = new()
{
    CheckDepositID = "check_deposit_f06n9gpg7sxn8t19lfc1"
};

var checkDeposit = await client.Simulations.CheckDeposits.Return(parameters);

Console.WriteLine(checkDeposit);

Parameters

check_deposit_id

string

Required

The identifier of the Check Deposit you wish to return.

More about Check Deposits.

Sandbox: Submit a Check Deposit

Simulates the submission of a Check Deposit to the Federal Reserve. This Check Deposit must first have a status of pending.

curl -X "POST" \
  --url "${INCREASE_URL}/simulations/check_deposits/check_deposit_f06n9gpg7sxn8t19lfc1/submit" \
  -H "Authorization: Bearer ${INCREASE_API_KEY}" \
  -H "Content-Type: application/json" \
  -d $'{}'

import Increase from 'increase';

const client = new Increase({
  apiKey: process.env['INCREASE_API_KEY'], // This is the default and can be omitted
});

const checkDeposit = await client.simulations.checkDeposits.submit(
  'check_deposit_f06n9gpg7sxn8t19lfc1',
);

console.log(checkDeposit.id);

import os
from increase import Increase

client = Increase(
    api_key=os.environ.get("INCREASE_API_KEY"),  # This is the default and can be omitted
)
check_deposit = client.simulations.check_deposits.submit(
    check_deposit_id="check_deposit_f06n9gpg7sxn8t19lfc1",
)
print(check_deposit.id)

require "increase"

increase = Increase::Client.new(
  api_key: ENV["INCREASE_API_KEY"] # This is the default and can be omitted
)

check_deposit = increase.simulations.check_deposits.submit("check_deposit_f06n9gpg7sxn8t19lfc1")

puts(check_deposit)

package main

import (
	"context"
	"fmt"
	"os"

	"github.com/Increase/increase-go"
	"github.com/Increase/increase-go/option"
)

func main() {
	client := increase.NewClient(
		option.WithAPIKey(os.Getenv("INCREASE_API_KEY")), // This is the default and can be omitted
	)
	checkDeposit, err := client.Simulations.CheckDeposits.Submit(
		context.TODO(),
		"check_deposit_f06n9gpg7sxn8t19lfc1",
		increase.SimulationCheckDepositSubmitParams{},
	)
	if err != nil {
		panic(err.Error())
	}
	fmt.Printf("%+v\n", checkDeposit.ID)
}

package com.increase.api.example;

import com.increase.api.client.IncreaseClient;
import com.increase.api.client.okhttp.IncreaseOkHttpClient;
import com.increase.api.models.checkdeposits.CheckDeposit;
import com.increase.api.models.simulations.checkdeposits.CheckDepositSubmitParams;

public final class Main {
    private Main() {}

    public static void main(String[] args) {
        IncreaseClient client = IncreaseOkHttpClient.fromEnv();

        CheckDeposit checkDeposit = client.simulations().checkDeposits().submit("check_deposit_f06n9gpg7sxn8t19lfc1");
    }
}

package com.increase.api.example

import com.increase.api.client.IncreaseClient
import com.increase.api.client.okhttp.IncreaseOkHttpClient
import com.increase.api.models.checkdeposits.CheckDeposit
import com.increase.api.models.simulations.checkdeposits.CheckDepositSubmitParams

fun main() {
    val client: IncreaseClient = IncreaseOkHttpClient.fromEnv()

    val checkDeposit: CheckDeposit = client.simulations().checkDeposits().submit("check_deposit_f06n9gpg7sxn8t19lfc1")
}

<?php

require_once dirname(__DIR__) . '/vendor/autoload.php';

use Increase\Client;
use Increase\Core\Exceptions\APIException;

$client = new Client(apiKey: getenv('INCREASE_API_KEY'));

try {
  $checkDeposit = $client->simulations->checkDeposits->submit(
    'check_deposit_f06n9gpg7sxn8t19lfc1',
    scan: [
      'accountNumber' => 'x',
      'routingNumber' => 'x',
      'auxiliaryOnUs' => 'x',
      'serialNumber' => 'x',
    ],
  );

  var_dump($checkDeposit);
} catch (APIException $e) {
  echo $e->getMessage();
}

using System;
using Increase.Api;
using Increase.Api.Models.Simulations.CheckDeposits;

IncreaseClient client = new();

CheckDepositSubmitParams parameters = new()
{
    CheckDepositID = "check_deposit_f06n9gpg7sxn8t19lfc1"
};

var checkDeposit = await client.Simulations.CheckDeposits.Submit(parameters);

Console.WriteLine(checkDeposit);

Parameters

check_deposit_id

string

Required

The identifier of the Check Deposit you wish to submit.

More about Check Deposits.

scan

dictionary

If set, the simulation will use these values for the check’s scanned MICR data. If not set, the simulation will use random values.