Private API Reference

Blockchain Addresses

Blockchain Addresses are single-chain, single-token. When the specified token is received at a Blockchain Address on the specified blockchain, they are automatically converted to USD and deposited into the associated Account. Other tokens, or specified tokens received on a different blockchain, will not be retrievable.

Events

Your application can listen to webhooks about this resource. The events about Blockchain Addresses will have the categories "blockchain_address.created" or "blockchain_address.updated" .

The Blockchain Address object

{
  "address": "0x304a554a310C7e546dfe434669C62820b7D83490",
  "blockchain": "ethereum",
  "created_at": "2020-01-31T23:59:59Z",
  "destination_account_id": "account_in71c4amph0vgo2qllky",
  "id": "blockchain_address_tijjpqp9t5d358ehydqi",
  "idempotency_key": null,
  "name": "My Wallet",
  "status": "active",
  "token": "usdc",
  "type": "blockchain_address"
}

Attributes

address

string

Nullable

The blockchain address. This will be null while the address is being provisioned.

blockchain

enum

The blockchain network.

created_at

string

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

destination_account_id

string

The Account funds will be deposited into when tokens are received at this address.

More about Accounts.

string

The Blockchain Address’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.

name

string

The name you chose for this Blockchain Address.

status

enum

The status of the Blockchain Address.

token

enum

The token that this address can receive.

type

string

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

List Blockchain Addresses

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

Returns a list response :

{
  "data": [
    { /* Blockchain Address object */ },
    { /* Blockchain Address object */ }
    /* ... */
  ],
  "next_cursor": "v57w5d",
}

Parameters

destination_account_id

string

Filter Blockchain Addresses to those for 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

status.in

array of strings

Return results whose value is in the provided list. For GET requests, this should be encoded as a comma-delimited string, such as ?in=one,two,three.

More parameters

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 Blockchain Address

curl -X "POST" \
  --url "${INCREASE_URL}/blockchain_addresses" \
  -H "Authorization: Bearer ${INCREASE_API_KEY}" \
  -H "Content-Type: application/json" \
  -d $'{
    "blockchain": "ethereum",
    "destination_account_id": "account_in71c4amph0vgo2qllky",
    "name": "My Wallet",
    "token": "usdc"
  }'

Parameters

blockchain

enum

Required

The blockchain network.

destination_account_id

string

Required

The identifier of the Account funds will be deposited into.

More about Accounts.

name

string

Required

A name you choose for this Blockchain Address.

Between 1 and 200 characters

token

enum

Required

The token this address will receive.

Retrieve a Blockchain Address

curl \
  --url "${INCREASE_URL}/blockchain_addresses/blockchain_address_tijjpqp9t5d358ehydqi" \
  -H "Authorization: Bearer ${INCREASE_API_KEY}"

Parameters

blockchain_address_id

string

Required

The identifier of the Blockchain Address.

More about Blockchain Addresses.

Update a Blockchain Address

curl -X "PATCH" \
  --url "${INCREASE_URL}/blockchain_addresses/blockchain_address_tijjpqp9t5d358ehydqi" \
  -H "Authorization: Bearer ${INCREASE_API_KEY}" \
  -H "Content-Type: application/json" \
  -d $'{
    "name": "New name"
  }'

Parameters

blockchain_address_id

string

Required

The blockchain address identifier.

More about Blockchain Addresses.

name

string

The description you choose to give the address.

Between 1 and 200 characters

status

enum

The status of the Blockchain Address.

Sandbox: Activate a Blockchain Address

Simulates the activation of a Blockchain Address. This populates the address field and changes the status to active.

curl -X "POST" \
  --url "${INCREASE_URL}/simulations/blockchain_addresses/blockchain_address_tijjpqp9t5d358ehydqi/activate" \
  -H "Authorization: Bearer ${INCREASE_API_KEY}"

Parameters

blockchain_address_id

string

Required

The identifier of the Blockchain Address you wish to activate.

More about Blockchain Addresses.