Private API Reference

Blockchain Off-Ramp Transfers

Blockchain Off-Ramp Transfers move funds from a Blockchain Address to an Account. They’re automatically created when funds land in a Blockchain Address.

Events

Your application can listen to webhooks about this resource. The events about Blockchain Off-Ramp Transfers will have the categories "blockchain_offramp_transfer.created" or "blockchain_offramp_transfer.updated" .

The Blockchain Off-Ramp Transfer object

{
  "amount": 10000,
  "created_at": "2020-01-31T23:59:59Z",
  "destination_account_id": "account_in71c4amph0vgo2qllky",
  "id": "blockchain_offramp_transfer_sqd2x3ti6u2sy91v696m",
  "initiating_transaction_hash": "0xcd7c2ab9e2075a3be3740c3a1f6e6e2c112e37d6b3f4a15e9e3e5a93b82c2c0a",
  "source_blockchain_address_id": "blockchain_address_tijjpqp9t5d358ehydqi",
  "status": "settled",
  "token": "usdc",
  "transaction_id": "transaction_uyrp7fld2ium70oa7oi",
  "type": "blockchain_offramp_transfer"
}

Attributes

amount

integer

The transfer amount in USD cents.

created_at

string

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

destination_account_id

string

The Account the funds were transferred into.

More about Accounts.

string

The Blockchain Off-Ramp Transfer’s identifier.

initiating_transaction_hash

string

The transaction hash of the blockchain transaction that initiated this transfer.

source_blockchain_address_id

string

The Blockchain Address from which the transfer originated.

More about Blockchain Addresses.

status

enum

The lifecycle status of the transfer.

token

enum

The token that was received.

transaction_id

string

Nullable

The Transaction crediting the Account once the transfer is settled.

More about Transactions.

type

string

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

List Blockchain Off-Ramp Transfers

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

Returns a list response :

{
  "data": [
    { /* Blockchain Off-Ramp Transfer object */ },
    { /* Blockchain Off-Ramp Transfer object */ }
    /* ... */
  ],
  "next_cursor": "v57w5d",
}

Parameters

destination_account_id

string

Filter Blockchain Off-Ramp Transfers to those for the specified Account.

More about Accounts.

source_blockchain_address_id

string

Filter Blockchain Off-Ramp Transfers to those from the specified Blockchain Address.

More about Blockchain Addresses.

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

Retrieve a Blockchain Off-Ramp Transfer

curl \
  --url "${INCREASE_URL}/blockchain_offramp_transfers/blockchain_offramp_transfer_sqd2x3ti6u2sy91v696m" \
  -H "Authorization: Bearer ${INCREASE_API_KEY}"

Parameters

blockchain_offramp_transfer_id

string

Required

The identifier of the Blockchain Off-Ramp Transfer.

More about Blockchain Off-Ramp Transfers.

Sandbox: Create a Blockchain Off-Ramp Transfer

Simulates receiving funds at a Blockchain Address. This creates a new Blockchain Off-Ramp Transfer.

curl -X "POST" \
  --url "${INCREASE_URL}/simulations/blockchain_offramp_transfers" \
  -H "Authorization: Bearer ${INCREASE_API_KEY}" \
  -H "Content-Type: application/json" \
  -d $'{
    "amount": 10000,
    "initiating_transaction_hash": "0xcd7c2ab9e2075a3be3740c3a1f6e6e2c112e37d6b3f4a15e9e3e5a93b82c2c0a",
    "source_blockchain_address_id": "blockchain_address_tijjpqp9t5d358ehydqi"
  }'

Parameters

amount

integer

Required

The transfer amount in USD cents.

initiating_transaction_hash

string

Required

The transaction hash of the blockchain transaction that initiated this transfer.

Between 1 and 200 characters

source_blockchain_address_id

string

Required

The identifier of the Blockchain Address that received the funds.

More about Blockchain Addresses.

Sandbox: Settle a Blockchain Off-Ramp Transfer

Simulates the settlement of a Blockchain Off-Ramp Transfer. This credits the funds to the associated Account.

curl -X "POST" \
  --url "${INCREASE_URL}/simulations/blockchain_offramp_transfers/blockchain_offramp_transfer_sqd2x3ti6u2sy91v696m/settle" \
  -H "Authorization: Bearer ${INCREASE_API_KEY}"

Parameters

blockchain_offramp_transfer_id

string

Required

The identifier of the Blockchain Off-Ramp Transfer you wish to settle.

More about Blockchain Off-Ramp Transfers.