Lockbox Addresses
Lockbox Addresses are physical locations that can receive mail containing paper checks.
The Lockbox Address object
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
{
"address": {
"city": "San Francisco",
"line1": "1234 Market St",
"line2": "Ste 567",
"postal_code": "94114",
"state": "CA"
},
"created_at": "2020-01-31T23:59:59Z",
"description": "Lockbox Address 1",
"id": "lockbox_address_lw6sbzl9ol5dfd8hdml6",
"idempotency_key": null,
"status": "active",
"type": "lockbox_address"
}
Attributes
address
dictionary
Nullable
The mailing address for the Lockbox Address. It will be present after Increase generates it.
created_at
string
The ISO 8601 time at which the Lockbox Address was created.
description
string
Nullable
The description you choose for the Lockbox Address.
id
string
The Lockbox Address 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.
status
enum
The status of the Lockbox Address.
type
string
A constant representing the object’s type. For this resource it will always be lockbox_address.
List Lockbox Addresses
1
2
3
curl \
--url "${INCREASE_URL}/lockbox_addresses" \
-H "Authorization: Bearer ${INCREASE_API_KEY}"1
2
3
4
5
6
7
8
9
10
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 lockboxAddress of client.lockboxAddresses.list()) {
console.log(lockboxAddress.id);
}1
2
3
4
5
6
7
8
9
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_addresses.list()
page = page.data[0]
print(page.id)1
2
3
4
5
6
7
8
9
require "increase"
increase = Increase::Client.new(
api_key: ENV["INCREASE_API_KEY"] # This is the default and can be omitted
)
page = increase.lockbox_addresses.list
puts(page)1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
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.LockboxAddresses.List(context.TODO(), increase.LockboxAddressListParams{})
if err != nil {
panic(err.Error())
}
fmt.Printf("%+v\n", page)
}
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
package com.increase.api.example;
import com.increase.api.client.IncreaseClient;
import com.increase.api.client.okhttp.IncreaseOkHttpClient;
import com.increase.api.models.lockboxaddresses.LockboxAddressListPage;
import com.increase.api.models.lockboxaddresses.LockboxAddressListParams;
public final class Main {
private Main() {}
public static void main(String[] args) {
IncreaseClient client = IncreaseOkHttpClient.fromEnv();
LockboxAddressListPage page = client.lockboxAddresses().list();
}
}1
2
3
4
5
6
7
8
9
10
11
12
package com.increase.api.example
import com.increase.api.client.IncreaseClient
import com.increase.api.client.okhttp.IncreaseOkHttpClient
import com.increase.api.models.lockboxaddresses.LockboxAddressListPage
import com.increase.api.models.lockboxaddresses.LockboxAddressListParams
fun main() {
val client: IncreaseClient = IncreaseOkHttpClient.fromEnv()
val page: LockboxAddressListPage = client.lockboxAddresses().list()
}1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
<?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->lockboxAddresses->list(
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();
}1
2
3
4
5
6
7
8
9
10
11
12
13
using System;
using Increase.Api;
using Increase.Api.Models.LockboxAddresses;
IncreaseClient client = new();
LockboxAddressListParams parameters = new();
var page = await client.LockboxAddresses.List(parameters);
await foreach (var item in page.Paginate())
{
Console.WriteLine(item);
}
Returns a
list response
:
1
2
3
4
5
6
7
8
{
"data": [
{ /* Lockbox Address object */ },
{ /* Lockbox Address object */ }
/* ... */
],
"next_cursor": "v57w5d",
}
Parameters
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.
More
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 Lockbox Address
1
2
3
4
5
6
7
curl -X "POST" \
--url "${INCREASE_URL}/lockbox_addresses" \
-H "Authorization: Bearer ${INCREASE_API_KEY}" \
-H "Content-Type: application/json" \
-d $'{
"description": "Lockbox Address 1"
}'1
2
3
4
5
6
7
8
9
import Increase from 'increase';
const client = new Increase({
apiKey: process.env['INCREASE_API_KEY'], // This is the default and can be omitted
});
const lockboxAddress = await client.lockboxAddresses.create();
console.log(lockboxAddress.id);1
2
3
4
5
6
7
8
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_address = client.lockbox_addresses.create()
print(lockbox_address.id)1
2
3
4
5
6
7
8
9
require "increase"
increase = Increase::Client.new(
api_key: ENV["INCREASE_API_KEY"] # This is the default and can be omitted
)
lockbox_address = increase.lockbox_addresses.create
puts(lockbox_address)1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
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
)
lockboxAddress, err := client.LockboxAddresses.New(context.TODO(), increase.LockboxAddressNewParams{})
if err != nil {
panic(err.Error())
}
fmt.Printf("%+v\n", lockboxAddress.ID)
}
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
package com.increase.api.example;
import com.increase.api.client.IncreaseClient;
import com.increase.api.client.okhttp.IncreaseOkHttpClient;
import com.increase.api.models.lockboxaddresses.LockboxAddress;
import com.increase.api.models.lockboxaddresses.LockboxAddressCreateParams;
public final class Main {
private Main() {}
public static void main(String[] args) {
IncreaseClient client = IncreaseOkHttpClient.fromEnv();
LockboxAddress lockboxAddress = client.lockboxAddresses().create();
}
}1
2
3
4
5
6
7
8
9
10
11
12
package com.increase.api.example
import com.increase.api.client.IncreaseClient
import com.increase.api.client.okhttp.IncreaseOkHttpClient
import com.increase.api.models.lockboxaddresses.LockboxAddress
import com.increase.api.models.lockboxaddresses.LockboxAddressCreateParams
fun main() {
val client: IncreaseClient = IncreaseOkHttpClient.fromEnv()
val lockboxAddress: LockboxAddress = client.lockboxAddresses().create()
}1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
<?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 {
$lockboxAddress = $client->lockboxAddresses->create(
description: 'Lockbox Address 1'
);
var_dump($lockboxAddress);
} catch (APIException $e) {
echo $e->getMessage();
}1
2
3
4
5
6
7
8
9
10
11
using System;
using Increase.Api;
using Increase.Api.Models.LockboxAddresses;
IncreaseClient client = new();
LockboxAddressCreateParams parameters = new();
var lockboxAddress = await client.LockboxAddresses.Create(parameters);
Console.WriteLine(lockboxAddress);
Parameters
description
string
The description you choose for the Lockbox Address.
Retrieve a Lockbox Address
1
2
3
curl \
--url "${INCREASE_URL}/lockbox_addresses/lockbox_address_lw6sbzl9ol5dfd8hdml6" \
-H "Authorization: Bearer ${INCREASE_API_KEY}"1
2
3
4
5
6
7
8
9
10
11
import Increase from 'increase';
const client = new Increase({
apiKey: process.env['INCREASE_API_KEY'], // This is the default and can be omitted
});
const lockboxAddress = await client.lockboxAddresses.retrieve(
'lockbox_address_lw6sbzl9ol5dfd8hdml6',
);
console.log(lockboxAddress.id);1
2
3
4
5
6
7
8
9
10
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_address = client.lockbox_addresses.retrieve(
"lockbox_address_lw6sbzl9ol5dfd8hdml6",
)
print(lockbox_address.id)1
2
3
4
5
6
7
8
9
require "increase"
increase = Increase::Client.new(
api_key: ENV["INCREASE_API_KEY"] # This is the default and can be omitted
)
lockbox_address = increase.lockbox_addresses.retrieve("lockbox_address_lw6sbzl9ol5dfd8hdml6")
puts(lockbox_address)1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
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
)
lockboxAddress, err := client.LockboxAddresses.Get(context.TODO(), "lockbox_address_lw6sbzl9ol5dfd8hdml6")
if err != nil {
panic(err.Error())
}
fmt.Printf("%+v\n", lockboxAddress.ID)
}
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
package com.increase.api.example;
import com.increase.api.client.IncreaseClient;
import com.increase.api.client.okhttp.IncreaseOkHttpClient;
import com.increase.api.models.lockboxaddresses.LockboxAddress;
import com.increase.api.models.lockboxaddresses.LockboxAddressRetrieveParams;
public final class Main {
private Main() {}
public static void main(String[] args) {
IncreaseClient client = IncreaseOkHttpClient.fromEnv();
LockboxAddress lockboxAddress = client.lockboxAddresses().retrieve("lockbox_address_lw6sbzl9ol5dfd8hdml6");
}
}1
2
3
4
5
6
7
8
9
10
11
12
package com.increase.api.example
import com.increase.api.client.IncreaseClient
import com.increase.api.client.okhttp.IncreaseOkHttpClient
import com.increase.api.models.lockboxaddresses.LockboxAddress
import com.increase.api.models.lockboxaddresses.LockboxAddressRetrieveParams
fun main() {
val client: IncreaseClient = IncreaseOkHttpClient.fromEnv()
val lockboxAddress: LockboxAddress = client.lockboxAddresses().retrieve("lockbox_address_lw6sbzl9ol5dfd8hdml6")
}1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
<?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 {
$lockboxAddress = $client->lockboxAddresses->retrieve(
'lockbox_address_lw6sbzl9ol5dfd8hdml6'
);
var_dump($lockboxAddress);
} catch (APIException $e) {
echo $e->getMessage();
}1
2
3
4
5
6
7
8
9
10
11
12
13
14
using System;
using Increase.Api;
using Increase.Api.Models.LockboxAddresses;
IncreaseClient client = new();
LockboxAddressRetrieveParams parameters = new()
{
LockboxAddressID = "lockbox_address_lw6sbzl9ol5dfd8hdml6"
};
var lockboxAddress = await client.LockboxAddresses.Retrieve(parameters);
Console.WriteLine(lockboxAddress);
Parameters
lockbox_address_id
string
Required
The identifier of the Lockbox Address to retrieve.
More about Lockbox Addresses.
Update a Lockbox Address
1
2
3
4
5
6
7
curl -X "PATCH" \
--url "${INCREASE_URL}/lockbox_addresses/lockbox_address_lw6sbzl9ol5dfd8hdml6" \
-H "Authorization: Bearer ${INCREASE_API_KEY}" \
-H "Content-Type: application/json" \
-d $'{
"status": "disabled"
}'1
2
3
4
5
6
7
8
9
import Increase from 'increase';
const client = new Increase({
apiKey: process.env['INCREASE_API_KEY'], // This is the default and can be omitted
});
const lockboxAddress = await client.lockboxAddresses.update('lockbox_address_lw6sbzl9ol5dfd8hdml6');
console.log(lockboxAddress.id);1
2
3
4
5
6
7
8
9
10
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_address = client.lockbox_addresses.update(
lockbox_address_id="lockbox_address_lw6sbzl9ol5dfd8hdml6",
)
print(lockbox_address.id)1
2
3
4
5
6
7
8
9
require "increase"
increase = Increase::Client.new(
api_key: ENV["INCREASE_API_KEY"] # This is the default and can be omitted
)
lockbox_address = increase.lockbox_addresses.update("lockbox_address_lw6sbzl9ol5dfd8hdml6")
puts(lockbox_address)1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
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
)
lockboxAddress, err := client.LockboxAddresses.Update(
context.TODO(),
"lockbox_address_lw6sbzl9ol5dfd8hdml6",
increase.LockboxAddressUpdateParams{},
)
if err != nil {
panic(err.Error())
}
fmt.Printf("%+v\n", lockboxAddress.ID)
}
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
package com.increase.api.example;
import com.increase.api.client.IncreaseClient;
import com.increase.api.client.okhttp.IncreaseOkHttpClient;
import com.increase.api.models.lockboxaddresses.LockboxAddress;
import com.increase.api.models.lockboxaddresses.LockboxAddressUpdateParams;
public final class Main {
private Main() {}
public static void main(String[] args) {
IncreaseClient client = IncreaseOkHttpClient.fromEnv();
LockboxAddress lockboxAddress = client.lockboxAddresses().update("lockbox_address_lw6sbzl9ol5dfd8hdml6");
}
}1
2
3
4
5
6
7
8
9
10
11
12
package com.increase.api.example
import com.increase.api.client.IncreaseClient
import com.increase.api.client.okhttp.IncreaseOkHttpClient
import com.increase.api.models.lockboxaddresses.LockboxAddress
import com.increase.api.models.lockboxaddresses.LockboxAddressUpdateParams
fun main() {
val client: IncreaseClient = IncreaseOkHttpClient.fromEnv()
val lockboxAddress: LockboxAddress = client.lockboxAddresses().update("lockbox_address_lw6sbzl9ol5dfd8hdml6")
}1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
<?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 {
$lockboxAddress = $client->lockboxAddresses->update(
'lockbox_address_lw6sbzl9ol5dfd8hdml6', description: 'x', status: 'disabled'
);
var_dump($lockboxAddress);
} catch (APIException $e) {
echo $e->getMessage();
}1
2
3
4
5
6
7
8
9
10
11
12
13
14
using System;
using Increase.Api;
using Increase.Api.Models.LockboxAddresses;
IncreaseClient client = new();
LockboxAddressUpdateParams parameters = new()
{
LockboxAddressID = "lockbox_address_lw6sbzl9ol5dfd8hdml6"
};
var lockboxAddress = await client.LockboxAddresses.Update(parameters);
Console.WriteLine(lockboxAddress);
Parameters
lockbox_address_id
string
Required
The identifier of the Lockbox Address.
More about Lockbox Addresses.
description
string
The description you choose for the Lockbox Address.
status
enum
The status of the Lockbox Address.