Lockbox Recipients

Lockbox Recipients represent an inbox at a Lockbox Address. Checks received for a Lockbox Recipient are deposited into its associated Account.

Events

Your application can listen to webhooks about this resource. The events about Lockbox Recipients will have the categories "lockbox.created" or "lockbox.updated".

The Lockbox Recipient object

{
  "account_id": "account_in71c4amph0vgo2qllky",
  "created_at": "2020-01-31T23:59:59Z",
  "description": null,
  "id": "lockbox_3xt21ok13q19advds4t5",
  "idempotency_key": null,
  "lockbox_address_id": "lockbox_address_lw6sbzl9ol5dfd8hdml6",
  "mail_stop_code": "VRE6P",
  "recipient_name": "Company Inc.",
  "status": "active",
  "type": "lockbox_recipient"
}

Attributes

account_id

string

The identifier for the Account that checks sent to this Lockbox Recipient will be deposited into.

More about Accounts.

created_at

string

The ISO 8601 time at which the Lockbox Recipient was created.

description

string

Nullable

The description of the Lockbox Recipient.

string

The Lockbox Recipient 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.

lockbox_address_id

string

The identifier for the Lockbox Address where this Lockbox Recipient may receive physical mail.

More about Lockbox Addresses.

mail_stop_code

string

The mail stop code uniquely identifying this Lockbox Recipient at its Lockbox Address. It should be included in the mailing address intended for this Lockbox Recipient.

recipient_name

string

Nullable

The name of the Lockbox Recipient.

status

enum

Nullable

The status of the Lockbox Recipient.

type

string

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

List Lockbox Recipients

curl \
  --url "${INCREASE_URL}/lockbox_recipients" \
  -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 lockboxRecipient of client.lockboxRecipients.list()) {
  console.log(lockboxRecipient.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.lockbox_recipients.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.lockbox_recipients.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.LockboxRecipients.List(context.TODO(), increase.LockboxRecipientListParams{})
	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.lockboxrecipients.LockboxRecipientListPage;
import com.increase.api.models.lockboxrecipients.LockboxRecipientListParams;

public final class Main {
    private Main() {}

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

        LockboxRecipientListPage page = client.lockboxRecipients().list();
    }
}

package com.increase.api.example

import com.increase.api.client.IncreaseClient
import com.increase.api.client.okhttp.IncreaseOkHttpClient
import com.increase.api.models.lockboxrecipients.LockboxRecipientListPage
import com.increase.api.models.lockboxrecipients.LockboxRecipientListParams

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

    val page: LockboxRecipientListPage = client.lockboxRecipients().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->lockboxRecipients->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,
    lockboxAddressID: 'lockbox_address_id',
  );

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

using System;
using Increase.Api;
using Increase.Api.Models.LockboxRecipients;

IncreaseClient client = new();

LockboxRecipientListParams parameters = new();

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

Returns a list response:

{
  "data": [
    { /* Lockbox Recipient object */ },
    { /* Lockbox Recipient object */ }
    /* ... */
  ],
  "next_cursor": "v57w5d",
}

Parameters

account_id

string

Filter Lockbox Recipients to those associated with the provided Account.

More about Accounts.

lockbox_address_id

string

Filter Lockbox Recipients to those associated with the provided Lockbox Address.

More about Lockbox Addresses.

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

More parameters

Create a Lockbox Recipient

curl -X "POST" \
  --url "${INCREASE_URL}/lockbox_recipients" \
  -H "Authorization: Bearer ${INCREASE_API_KEY}" \
  -H "Content-Type: application/json" \
  -d $'{
    "account_id": "account_in71c4amph0vgo2qllky",
    "lockbox_address_id": "lockbox_address_lw6sbzl9ol5dfd8hdml6",
    "recipient_name": "Ian Crease"
  }'

import Increase from 'increase';

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

const lockboxRecipient = await client.lockboxRecipients.create({
  account_id: 'account_in71c4amph0vgo2qllky',
  lockbox_address_id: 'lockbox_address_lw6sbzl9ol5dfd8hdml6',
});

console.log(lockboxRecipient.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
)
lockbox_recipient = client.lockbox_recipients.create(
    account_id="account_in71c4amph0vgo2qllky",
    lockbox_address_id="lockbox_address_lw6sbzl9ol5dfd8hdml6",
)
print(lockbox_recipient.id)

require "increase"

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

lockbox_recipient = increase.lockbox_recipients.create(
  account_id: "account_in71c4amph0vgo2qllky",
  lockbox_address_id: "lockbox_address_lw6sbzl9ol5dfd8hdml6"
)

puts(lockbox_recipient)

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
	)
	lockboxRecipient, err := client.LockboxRecipients.New(context.TODO(), increase.LockboxRecipientNewParams{
		AccountID:        increase.F("account_in71c4amph0vgo2qllky"),
		LockboxAddressID: increase.F("lockbox_address_lw6sbzl9ol5dfd8hdml6"),
	})
	if err != nil {
		panic(err.Error())
	}
	fmt.Printf("%+v\n", lockboxRecipient.ID)
}

package com.increase.api.example;

import com.increase.api.client.IncreaseClient;
import com.increase.api.client.okhttp.IncreaseOkHttpClient;
import com.increase.api.models.lockboxrecipients.LockboxRecipient;
import com.increase.api.models.lockboxrecipients.LockboxRecipientCreateParams;

public final class Main {
    private Main() {}

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

        LockboxRecipientCreateParams params = LockboxRecipientCreateParams.builder()
            .accountId("account_in71c4amph0vgo2qllky")
            .lockboxAddressId("lockbox_address_lw6sbzl9ol5dfd8hdml6")
            .build();
        LockboxRecipient lockboxRecipient = client.lockboxRecipients().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.lockboxrecipients.LockboxRecipient
import com.increase.api.models.lockboxrecipients.LockboxRecipientCreateParams

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

    val params: LockboxRecipientCreateParams = LockboxRecipientCreateParams.builder()
        .accountId("account_in71c4amph0vgo2qllky")
        .lockboxAddressId("lockbox_address_lw6sbzl9ol5dfd8hdml6")
        .build()
    val lockboxRecipient: LockboxRecipient = client.lockboxRecipients().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 {
  $lockboxRecipient = $client->lockboxRecipients->create(
    accountID: 'account_in71c4amph0vgo2qllky',
    lockboxAddressID: 'lockbox_address_lw6sbzl9ol5dfd8hdml6',
    description: 'x',
    recipientName: 'Ian Crease',
  );

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

using System;
using Increase.Api;
using Increase.Api.Models.LockboxRecipients;

IncreaseClient client = new();

LockboxRecipientCreateParams parameters = new()
{
    AccountID = "account_in71c4amph0vgo2qllky",
    LockboxAddressID = "lockbox_address_lw6sbzl9ol5dfd8hdml6",
};

var lockboxRecipient = await client.LockboxRecipients.Create(parameters);

Console.WriteLine(lockboxRecipient);

Parameters

account_id

string

Required

The Account that checks sent to this Lockbox Recipient should be deposited into.

More about Accounts.

description

string

The description you choose for the Lockbox Recipient.

Between 1 and 200 characters

lockbox_address_id

string

Required

The Lockbox Address where this Lockbox Recipient may receive mail. The Lockbox Address must have a status of active.

More about Lockbox Addresses.

recipient_name

string

The name of the Lockbox Recipient.

Between 1 and 200 characters

Retrieve a Lockbox Recipient

curl \
  --url "${INCREASE_URL}/lockbox_recipients/lockbox_3xt21ok13q19advds4t5" \
  -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 lockboxRecipient = await client.lockboxRecipients.retrieve('lockbox_3xt21ok13q19advds4t5');

console.log(lockboxRecipient.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
)
lockbox_recipient = client.lockbox_recipients.retrieve(
    "lockbox_3xt21ok13q19advds4t5",
)
print(lockbox_recipient.id)

require "increase"

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

lockbox_recipient = increase.lockbox_recipients.retrieve("lockbox_3xt21ok13q19advds4t5")

puts(lockbox_recipient)

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
	)
	lockboxRecipient, err := client.LockboxRecipients.Get(context.TODO(), "lockbox_3xt21ok13q19advds4t5")
	if err != nil {
		panic(err.Error())
	}
	fmt.Printf("%+v\n", lockboxRecipient.ID)
}

package com.increase.api.example;

import com.increase.api.client.IncreaseClient;
import com.increase.api.client.okhttp.IncreaseOkHttpClient;
import com.increase.api.models.lockboxrecipients.LockboxRecipient;
import com.increase.api.models.lockboxrecipients.LockboxRecipientRetrieveParams;

public final class Main {
    private Main() {}

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

        LockboxRecipient lockboxRecipient = client.lockboxRecipients().retrieve("lockbox_3xt21ok13q19advds4t5");
    }
}

package com.increase.api.example

import com.increase.api.client.IncreaseClient
import com.increase.api.client.okhttp.IncreaseOkHttpClient
import com.increase.api.models.lockboxrecipients.LockboxRecipient
import com.increase.api.models.lockboxrecipients.LockboxRecipientRetrieveParams

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

    val lockboxRecipient: LockboxRecipient = client.lockboxRecipients().retrieve("lockbox_3xt21ok13q19advds4t5")
}

<?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 {
  $lockboxRecipient = $client->lockboxRecipients->retrieve(
    'lockbox_3xt21ok13q19advds4t5'
  );

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

using System;
using Increase.Api;
using Increase.Api.Models.LockboxRecipients;

IncreaseClient client = new();

LockboxRecipientRetrieveParams parameters = new()
{
    LockboxRecipientID = "lockbox_3xt21ok13q19advds4t5"
};

var lockboxRecipient = await client.LockboxRecipients.Retrieve(parameters);

Console.WriteLine(lockboxRecipient);

Parameters

lockbox_recipient_id

string

Required

The identifier of the Lockbox Recipient to retrieve.

More about Lockbox Recipients.

Update a Lockbox Recipient

curl -X "PATCH" \
  --url "${INCREASE_URL}/lockbox_recipients/lockbox_3xt21ok13q19advds4t5" \
  -H "Authorization: Bearer ${INCREASE_API_KEY}" \
  -H "Content-Type: application/json" \
  -d $'{
    "status": "active"
  }'

import Increase from 'increase';

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

const lockboxRecipient = await client.lockboxRecipients.update('lockbox_3xt21ok13q19advds4t5');

console.log(lockboxRecipient.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
)
lockbox_recipient = client.lockbox_recipients.update(
    lockbox_recipient_id="lockbox_3xt21ok13q19advds4t5",
)
print(lockbox_recipient.id)

require "increase"

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

lockbox_recipient = increase.lockbox_recipients.update("lockbox_3xt21ok13q19advds4t5")

puts(lockbox_recipient)

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
	)
	lockboxRecipient, err := client.LockboxRecipients.Update(
		context.TODO(),
		"lockbox_3xt21ok13q19advds4t5",
		increase.LockboxRecipientUpdateParams{},
	)
	if err != nil {
		panic(err.Error())
	}
	fmt.Printf("%+v\n", lockboxRecipient.ID)
}

package com.increase.api.example;

import com.increase.api.client.IncreaseClient;
import com.increase.api.client.okhttp.IncreaseOkHttpClient;
import com.increase.api.models.lockboxrecipients.LockboxRecipient;
import com.increase.api.models.lockboxrecipients.LockboxRecipientUpdateParams;

public final class Main {
    private Main() {}

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

        LockboxRecipient lockboxRecipient = client.lockboxRecipients().update("lockbox_3xt21ok13q19advds4t5");
    }
}

package com.increase.api.example

import com.increase.api.client.IncreaseClient
import com.increase.api.client.okhttp.IncreaseOkHttpClient
import com.increase.api.models.lockboxrecipients.LockboxRecipient
import com.increase.api.models.lockboxrecipients.LockboxRecipientUpdateParams

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

    val lockboxRecipient: LockboxRecipient = client.lockboxRecipients().update("lockbox_3xt21ok13q19advds4t5")
}

<?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 {
  $lockboxRecipient = $client->lockboxRecipients->update(
    'lockbox_3xt21ok13q19advds4t5',
    description: 'x',
    recipientName: 'x',
    status: 'active',
  );

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

using System;
using Increase.Api;
using Increase.Api.Models.LockboxRecipients;

IncreaseClient client = new();

LockboxRecipientUpdateParams parameters = new()
{
    LockboxRecipientID = "lockbox_3xt21ok13q19advds4t5"
};

var lockboxRecipient = await client.LockboxRecipients.Update(parameters);

Console.WriteLine(lockboxRecipient);

Parameters

lockbox_recipient_id

string

Required

The identifier of the Lockbox Recipient.

More about Lockbox Recipients.

description

string

The description you choose for the Lockbox Recipient.

Between 1 and 200 characters

recipient_name

string

The name of the Lockbox Recipient.

Between 1 and 200 characters

status

enum

The status of the Lockbox Recipient.