Private API Reference

Blockchain On-Ramp Transfers

Blockchain On-Ramp Transfers move funds from an Account to a blockchain address.

Events

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

The Blockchain On-Ramp Transfer object

{
  "account_id": "account_in71c4amph0vgo2qllky",
  "amount": 10000,
  "blockchain": "ethereum",
  "confirmation": {
    "confirmed_at": "2020-01-31T23:59:59Z",
    "transaction_hash": "0xcd7c2ab9e2075a3be3740c3a1f6e6e2c112e37d6b3f4a15e9e3e5a93b82c2c0a"
  },
  "created_at": "2020-01-31T23:59:59Z",
  "created_by": {
    "category": "user",
    "user": {
      "email": "user@example.com"
    }
  },
  "description": "Moving funds on-chain",
  "destination_blockchain_address": "0xaabbccdd",
  "id": "blockchain_onramp_transfer_sg8nzy569rk0dnfk28bv",
  "idempotency_key": null,
  "pending_transaction_id": null,
  "status": "confirmed",
  "token": "usdc",
  "transaction_id": "transaction_uyrp7fld2ium70oa7oi",
  "type": "blockchain_onramp_transfer"
}

Attributes

account_id

string

The Account from which the transfer was sent.

More about Accounts.

amount

integer

The transfer amount in USD cents.

blockchain

enum

The blockchain network.

confirmation

dictionary

Nullable

If the transfer is confirmed, this will contain details of the confirmation.

created_at

string

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

created_by

dictionary

Nullable

What object created the transfer, either via the API or the dashboard.

description

string

Nullable

A description you provided for the transfer.

destination_blockchain_address

string

The blockchain address the funds are being sent to.

string

The Blockchain On-Ramp Transfer’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.

pending_transaction_id

string

Nullable

The ID for the pending transaction representing the transfer while it is pending.

More about Pending Transactions.

status

enum

The lifecycle status of the transfer.

token

enum

The token being transferred.

transaction_id

string

Nullable

The Transaction funding the transfer once it is complete.

More about Transactions.

type

string

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

List Blockchain On-Ramp Transfers

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

Returns a list response :

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

Parameters

account_id

string

Filter Blockchain On-Ramp Transfers 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

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 On-Ramp Transfer

curl -X "POST" \
  --url "${INCREASE_URL}/blockchain_onramp_transfers" \
  -H "Authorization: Bearer ${INCREASE_API_KEY}" \
  -H "Content-Type: application/json" \
  -d $'{
    "amount": 10000,
    "blockchain": "ethereum",
    "description": "Moving funds on-chain",
    "destination_blockchain_address": "0x304a554a310C7e546dfe434669C62820b7D83490",
    "source_account_id": "account_in71c4amph0vgo2qllky",
    "token": "usdc"
  }'

Parameters

amount

integer

Required

The transfer amount in USD cents.

blockchain

enum

Required

The blockchain network.

description

string

A description you choose for the transfer.

Between 1 and 140 characters

destination_blockchain_address

string

Required

The blockchain address to send the funds to.

Between 1 and 200 characters

source_account_id

string

Required

The identifier of the Account from which to send the transfer.

More about Accounts.

token

enum

Required

The token to transfer.

Retrieve a Blockchain On-Ramp Transfer

curl \
  --url "${INCREASE_URL}/blockchain_onramp_transfers/blockchain_onramp_transfer_sg8nzy569rk0dnfk28bv" \
  -H "Authorization: Bearer ${INCREASE_API_KEY}"

Parameters

blockchain_onramp_transfer_id

string

Required

The identifier of the Blockchain On-Ramp Transfer.

More about Blockchain On-Ramp Transfers.

Sandbox: Confirm a Blockchain On-Ramp Transfer

Simulates the confirmation of a Blockchain On-Ramp Transfer on the blockchain. This transfer must first have a status of pending_review, pending_submission, or pending_confirmation.

curl -X "POST" \
  --url "${INCREASE_URL}/simulations/blockchain_onramp_transfers/blockchain_onramp_transfer_sg8nzy569rk0dnfk28bv/confirm" \
  -H "Authorization: Bearer ${INCREASE_API_KEY}"

Parameters

blockchain_onramp_transfer_id

string

Required

The identifier of the Blockchain On-Ramp Transfer you wish to confirm.

More about Blockchain On-Ramp Transfers.