# Wallet

The Apirone wallet is an essential tool for operating with a certain cryptocurrency. Basically it is a container of addresses, which are generated as many as need. Apirone API can create wallets, send and receive payments, estimate transaction fees, use callback function, and far more.

# Create Wallet

Generates a wallet.

# Request

  • HTTP Method: POST
  • Content Type: application/json
  • URL: https://apirone.com/api/v2/wallets
Parameter Type Description Required
currency string Currency type (any cryptocurrency supported by service)
callback object Callback url and data
destinations array The array of objects of destination addresses and amounts. An amount can be integer or percentage
fee object Network fee strategy

# Callback

Once the wallet is created, an optional callback parameter can be applied to control certain operations, e.g. confirmation of transactions, receipt of funds, and so on. It is an object of a specified URL page and user's data parameters.

Parameter Type Description Required
method string HTTP method of referring to the server with the callback.
For example, GET, POST
url string Customer server's callback URL to receive data about the payment. This must be a valid URL and less then 1024 characters
data object This object is based on key-value pairs. For example, customer_id = 345467

# Destinations [array]

Parameter Type Description Required
address string Destination(s) crypto address(es) where confirmed payments will be forwarded to.
Minimum 1, maximum 255 destination addresses
amount string Destination addresses shall either have values specified in percentage or be empty to be forwarded 100%.
In this case, the rest amount will be forwarded there. The amount is indicated in minor units

# Request example

curl -X POST 'https://apirone.com/api/v2/wallets' \
-H 'Content-Type: application/json' \
-d '{
      "currency": "btc",
      "callback": {
        "url": "https://example.com",
        "data": {
            "optional_key": "key"
        }
      },
      "destinations": [
        {
            "address": "38cSD2nhmfVbXb9gRu8qVcLtyW6q8NVLQb",
            "amount": "50%"
        },
        {
            "address": "38tpmrkWEn9bdgQ2btGQjsuzCiUqSwdGHD"
        }
      ],
      "fee": "priority"
    }'

# Success Response Reference

  • HTTP Status Code: 200
  • Content Type: application/json
Parameter Type Description
wallet string Wallet Identifier
created string Wallet creation date. Contains the full date, hours, minutes, seconds, decimal part of seconds in in ISO-8601 (opens new window) format (for example, 2022-02-02T15:00:00)
transfer-key string Key for payment transfer
callback object This object consists of callback URL and user's Data parameters
destinations array Destinations array
fee object Network fee strategy

# Response example

  {
    "wallet": "btc-f43a47823c6f0894c83e3e364fa12654",
    "created": "2021-11-12T11:03:55.083199",
    "currency": "btc",
    "transfer-key": "4sSm9aeXQiqMBmeEs42NTjZidJuGrqm7",
    "callback":{                     
      "url": "https://example.com",  
      "data":{                    
         "optional_key": "key"
      }
    },
    "destinations": [
        {
            "address": "38cSD2nhmfVbXb9gRu8qVcLtyW6q8NVLQb",
            "amount": "50%"
        },
        {
            "address": "38tpmrkWEn9bdgQ2btGQjsuzCiUqSwdGHD"
        }
    ],
    "fee": "priority"
  }

# Error response

  • HTTP Status Code: 400 500
  • Content Type: application/json

Playground

# Wallet Info

Gets information about the wallet.

# Request

  • HTTP Method: GET
  • Content Type: application/json
  • URL: https://apirone.com/api/v2/wallets/{wallet}
Parameter Type Description Required
wallet string Wallet Identifier

# Request example

curl 'https://apirone.com/api/v2/wallets/btc-f43a47823c6f0894c83e3e364fa12654'

# Success Response Reference

  • HTTP Status Code: 200
  • Content Type: application/json
Parameter Type Description
wallet string Wallet Identifier
created string Wallet creation date. Contains the full date, hours, minutes, seconds, decimal part of seconds in in ISO-8601 (opens new window) format (for example, 2022-02-02T15:00:00)
currency string Currency type
units string Cryptocurrency units. Units for all amount values for a specified wallet
destinations array The array of dictionaries consisting of destination addresses and amounts
fee object Network fee strategy

# Response example

{
    "wallet": "btc-f43a47823c6f0894c83e3e364fa12654",
    "currency": "btc",
    "created": "2021-12-21T08:15:22.859516",
    "units": "satoshi",
    "destinations": [
        {
            "address": "3ESbdZmmPNvi65oeBgXARXVaVQbArbX6x3",
            "amount": "100%"
        }
    ],
    "fee": "normal"
}

# Error response

  • HTTP Status Code: 400 500
  • Content Type: application/json

Playground

# Wallet balance

# Request

  • HTTP Method: GET
  • URL: https://apirone.com/api/v2/wallets/{wallet}/balance
Parameter Type Description Required
wallet string Wallet Identifier
addresses string Optional parameter for checking balance of specified comma separated addresses

# Request Example

curl 'https://apirone.com/api/v2/wallets/btc-f43a47823c6f0894c83e3e364fa12654/balance?addresses=3ESbdZmmPNvi65oeBgXARXVaVQbArbX6x3'

# Success Response Reference

  • HTTP Status Code: 200
  • Content Type: application/json
Parameter Type Description
wallet string Wallet Identifier
available integer Available balance for transfer
total integer Available and also unconfirmed balance

# Response example

{
    "wallet": "btc-f43a47823c6f0894c83e3e364fa12654",
    "available": 49382493,
    "total": 49382493
}

# Error Response

  • HTTP Status Code: 400 500
  • Content type: application/json

Playground

# Generate Address

This function generates unique crypto addresses to use. There are no expiration date and no transaction limit for addresses.

# Request

  • HTTP Method: POST
  • Content Type: application/json
  • URL: https://apirone.com/api/v2/wallets/{wallet}/addresses

In the request body you can set an address type and add callback data.

Parameter Type Description Required
wallet string Wallet Identifier
addr-type string Address type. More information about address types for all cryptocurrencies in our service see here
callback object More information see here

# Request example

curl -X POST 'https://apirone.com/api/v2/wallets/btc-f43a47823c6f0894c83e3e364fa12654/addresses' \
-H 'Content-Type: application/json' \
-d '{
        "addr-type": "p2sh-p2wpkh",
        "callback": {
            "method": "POST",
            "url": "http://example.com/callback",
            "data": {
                "id": "12345"
            }
        }
    }'

# Success Response Reference

  • HTTP Status Code: 200
  • Content Type: application/json
Parameter Type Description
wallet string Wallet Identifier
address string The generated crypto address to receive payment from
created string Address creation date.
Contains the full date, hours, minutes, seconds, decimal part of seconds: (for example, 2022-02-02T15:00:00)
type string Address type
callback object Callback url and data

# Response example

{
    "wallet": "btc-f43a47823c6f0894c83e3e364fa12654",
    "address": "3EHvR46WZTc3rQoessnuvdMHRt1EoVMHab",
    "created": "2021-11-04T08:38:33.389076",
    "type": "p2sh-p2wpkh",
    "callback": {
        "method": "POST",
        "url": "http://example.com/callback",
        "data": {
            "id": "12345"
        }
    }
}

# Error Response

  • HTTP Status Code: 400 500
  • Content type: application/json

Playground

# Address Info

Some information can be requested about an address in a selected wallet: address type, creation date etc.

# Request

  • HTTP Method: GET
  • URL: https://apirone.com/api/v2/wallets/{wallet}/addresses/{address}
Parameter Type Description Required
wallet string Wallet Identifier
address string Cryptocurrency address

# Request example

curl 'https://apirone.com/api/v2/wallets/btc-f43a47823c6f0894c83e3e364fa12654/addresses/3EHvR46WZTc3rQoessnuvdMHRt1EoVMHab'

# Success Response Reference

  • HTTP Status Code: 200
  • Content Type: application/json
Parameter Type Description
wallet string Wallet Identifier
address string Cryptocurrency address
type string Address type
created string Address creation date. Contains the full date, hours, minutes, seconds, decimal part of seconds in in ISO-8601 (opens new window) format (for example, 2022-02-02T15:00:00)
balance object Contains information about the current balance of the address:
available - the amount available for payment
total - the entire balance of the address, including the one that cannot be used at the moment due to waiting for confirmation or for other reasons

# Response example

{
    "wallet": "btc-f43a47823c6f0894c83e3e364fa12654",
    "address": "3EHvR46WZTc3rQoessnuvdMHRt1EoVMHab",
    "type": "p2sh-p2wpkh",
    "created": "2021-11-04T09:50:17.375459",
    "balance": {
        "available": 999500,
        "total": 999500
    }
}

# Error response

  • HTTP Status Code: 400 500
  • Content Type: application/json

Playground

# Address Balance

Gets the balance of a specified address from wallet.

# Request

  • HTTP Method: GET
  • URL: https://apirone.com/api/v2/wallets/{wallet}/addresses/{address}/balance
Parameter Type Description Required
wallet string Wallet Identifier
address string Cryptocurrency address

# Request example

curl 'https://apirone.com/api/v2/wallets/btc-f43a47823c6f0894c83e3e364fa12654/addresses/3EHvR46WZTc3rQoessnuvdMHRt1EoVMHab/balance'

# Success Response Reference

  • HTTP Status Code: 200
  • Content Type: application/json
Parameter Type Description
wallet string Wallet Identifier
address string Cryptocurrency address
available integer Balance available for transfer
total integer Available and unconfirmed balance

# Response example

{
   "wallet": "btc-f43a47823c6f0894c83e3e364fa12654",
    "address": "3EHvR46WZTc3rQoessnuvdMHRt1EoVMHab",
    "available": 0,
    "total": 0
}

# Error response

  • HTTP Status Code: 400 500
  • Content Type: application/json

Playground

# Wallet Addresses

Returns a list of all the wallet addresses. Contains short information about each address.

# Request

  • HTTP Method: GET
  • URL: https://apirone.com/api/v2/wallets/{wallet}/addresses
Parameter Type Description Required
wallet string Wallet Identifier
limit integer Maximum number of items returning by response.
Default value: 10
offset integer Sequential number of the element from which the counting starts.
Default value: 0
q string Filter items by specific criteria

The filter q is assembled into a string by bare listing the variables in the string, separated by commas. A colon is used as a separator between the parameter name and the value. Contains the following options:

Parameter Type Description Required
addresses string Cryptocurrency address (or part of it)
empty boolean Includes addresses with zero balances to response if true. Takes the only false value

Example of q:

address:38cSD2nhmfVbXb9gRu8qVcLtyW6q8NVLQb,empty:false

# Request example

curl 'https://apirone.com/api/v2/wallets/btc-f43a47823c6f0894c83e3e364fa12654/addresses?limit=10&offset=0&q=empty:true,address:38cSD2nhmfVbXb9gRu8qVcLtyW6q8NVLQb'

# Success Response Reference

  • HTTP Status Code: 200
  • Content Type: application/json
Parameter Type Description
wallet string Wallet Identifier
addresses array An array containing information about addresses
pagination object Pagination info

addresses contains the following data:

Parameter Type Description
address string Cryptocurrency address
type string Address type
created string Address creation date.
Timestamp when the address was created (UTC date, ISO-8601 (opens new window)
balance object Information about the current balance of the address:
available - the amount available for payment;
total - the entire balance of the address

Elements pagination:

Parameter Description
total Total number of addresses
offset The sequence number of the element from which the counting starts. Default value: 0
limit Number of items returned in response.
Default value: 10

# Response example

  {

    "wallet": "btc-f43a47823c6f0894c83e3e364fa12654",
    "addresses": [
        {
            "wallet": "btc-f43a47823c6f0894c83e3e364fa12654",
            "address": "38cSD2nhmfVbXb9gRu8qVcLtyW6q8NVLQb",
            "type": "p2sh-p2wpkh",
            "created": "2022-01-17T06:41:36.921309",
            "balance": {
                "available": 0,
                "total": 100000
            }
        }
    ],
    "pagination": {
        "total": 1,
        "offset": 0,
        "limit": 10
    }
  
  }

# Error response

  • HTTP Status Code: 400 500
  • Content Type: application/json

Playground

# Estimation

Estimates a transaction before sending.

# Request

  • HTTP Method: GET
  • URL: https://apirone.com/api/v2/wallets/{wallet}/transfer
Parameter Type Description Required
wallet string Wallet Identifier
destinations string Comma separated address and colon separated amount pairs.
For example,38cSD2nhmfVbXb9gRu8qVcLtyW6q8NVLQb:10000,32sFoUrsh5zYhi9k9T1jyGc3EqqVG2aeqp:20%
fee object Network fee strategy
subtract-fee-from-amount boolean If it takes "true", then the fee will be proportionally subtracted from each destination's amount
addresses string Optional parameter for estimation of a transfer from specified address or multiple comma separated addresses

# Request Example

curl 'https://apirone.com/api/v2/wallets/btc-f43a47823c6f0894c83e3e364fa12654/transfer?addresses=35Gnk75DbehHXkshBX1QzpKdq4AJDW6KKv&destinations=3QSx5y7g5DZojZbGTsNSNJ5kPBTF56h6Kz:10107111&fee=normal&subtract_fee_from_amount=true'

# Success Response Reference

  • HTTP Status Code: 200
  • Content Type: application/json
Parameter Type Description
wallet string Wallet Identifier
destinations array Array of dictionaries:
address - recipient's address,
amount - payment amount
amount integer Transfer amount
total integer Total amount of transfer. Includes the amount of all fees and the amount of transfer
fee object Network fee strategy

# Response example

  {
      "destinations": [
        {
        "address": "35Gnk75DbehHXkshBX1QzpKdq4AJDW6KKv",
        "amount": 10000
        },
        {
        "address": "3QSx5y7g5DZojZbGTsNSNJ5kPBTF56h6Kz",
        "amount": 10107111
        } 
      ],
      "amount": 10117276,
      "total": 10117276,
      "fee": {
        "subtract-from-amount": true,
        "processing": {
          "address": "35Gnk75DbehHXkshBX1QzpKdq4AJDW6KKv",
          "amount": 10000
        },
        "network": {
          "strategy": "normal",
          "amount": 165,
          "rate": 1.0
        }
      }
  }

# Error Response

  • HTTP Status Code: 400 500
  • Content type: application/json

Playground

# Transfer

Transfers funds to specified destinations. Authorization is required.

# Request

  • HTTP Method: POST
  • URL: https://apirone.com/api/v2/wallets/{wallet}/transfer
Parameter Type Description Required
wallet string Wallet Identifier
transfer-key string Key for payment transfer *
destinations array Destinations array. The amount is indicated in minor units
fee object Network fee strategy
subtract-fee-from-amount boolean If it takes true, then the fee will be proportionally subtracted from each destination's amount
addresses array Optional parameter for transfer from specified addresses only (comma separated)
fee-rate integer The parameter is only used when "custom" is set to fee. It's used to set the value of the network fee

* transfer-key is required unless access token is applied

# Request Example

curl -X POST 'https://apirone.com/api/v2/wallets/btc-f43a47823c6f0894c83e3e364fa12654/transfer' \
-H 'Content-Type: application/json' \
-d '{
   "transfer_key": "a0Nzd08rZBcGbdo7sjat9u2jN9FG3xjE",
   "addresses": [
        "3MvDS9DnYJe6rycHieUFKcBKBMfQJ2sJ8wd",
        "3MxA4bJJxSKY9zZD8Cp3c2br9uKghHMiWRf"
   ],
   "destinations": [
       {
           "address": "3HmjxAZwoWjsJd8mig89qfn2rzFtxXYW4z",
           "amount": 40000
       }
   ],
   "fee": "normal",
   "subtract-fee-from-amount": true
}'

# Success Response Reference

  • HTTP Status Code: 200
  • Content Type: application/json
Parameter Type Description
wallet string Wallet Identifier
created string Item creation date
type string Item type (payment)
id string Payment Id
txs array The array of transactions hashes
destinations array Destinations array
amount integer Transfer amount
total integer Total amount of transfer.
Includes the amount of all fees and the amount of transfer
fee object Network fee strategy
change-address string If sent transaction has a change, then the latter will be sent to a new wallet's address

# Response example

{ 
  "wallet": "btc-f43a47823c6f0894c83e3e364fa12654",
    "created": "2022-01-14T12:43:35.606395",
    "type": "payment",
    "id": "ad2340b05aee5e12b6f5bb2702b7eb4a6b07975c68356d0b39709bd59597a22e",
    "txs": [
        "0e3c03304cdc6a02faaf0bb3c7c2730010f66e55d9a591bebfe2093925b5d505"
    ],
    "destinations": [
        {
            "address": "3HmjxAZwoWjsJd8mig89qfn2rzFtxXYW4z",
            "amount": 40000
        }
    ],
    "amount": 40256,
    "total": 40256,
    "fee": {
        "subtract-from-amount": true,
        "network": {
            "strategy": "normal",
            "amount": 256,
            "rate": 1.0
        }
    },
    "change-address": "3MxA6DZL5KNt5zuWgZ51KEvBSzodywUpxcD"
}

# Error Response

  • HTTP Status Code: 400 500
  • Content type: application/json

Playground

# Wallet History

Request wallet transaction history, including opportunities to filter by address, transfer date (calendar period) and type (payment or receipt). A payment is an element created as a result of transferring funds from a wallet. It combines all blockchain transactions of the payment and contains detailed information about fees and recipients. A receipt is an incoming transfer, which shows a new arrival of funds to a wallet.

# Request

  • HTTP Method: GET
  • URL: https://apirone.com/api/v2/wallets/{wallet}/history
Parameter Type Description Required
wallet string Wallet Identifier
limit integer Maximum number of transactions displayed on the page.
Default value: 10
offset integer Sequential number of the element from which the counting starts.
Default value: 0
q string Filter items by specific criteria
addresses string Optional parameter for checking history of specified addresses only

Filters can be included in q:

Parameter Type Description Required
address string The whole or the part of a crypto address
date_from string The start date of the calendar period in which the transfer occurred.
Contains the full date in ISO-8601 (opens new window), for example, 2022-10-13T00:00:01+04:00
date_to string The end date of the calendar period. It is the full date in ISO-8601 (opens new window), for example, 2022-10-15T00:00:01+04:00
item_type string Item type: payment or receipt

Example of q string:

q=item_type:receipt,address:35Gnk75DbehHXkshBX1QzpKdq4AJDW6KKv,date_from:2021-02-01T00:00:01+01:00,date_to:2021-03-01T23:59:59+01:00

Request example

curl 'https://apirone.com/api/v2/wallets/btc-f43a47823c6f0894c83e3e364fa12654/history?addresses=3MLabTPozkYjNgsFXpKUTezq7PivcHEVrR,3AxJPb8eA4jqPsC2xgfUNBp8aJ3HaPNdsv&limit=10&offset=0&q=date_from:2021-01-01T00:00:01+04:00,date_to:2021-01-31T23:59:59+04:00,item_type:payment'

# Success Response Reference

  • HTTP Status Code: 200
  • Content Type: application/json
Parameter Type Description
wallet string Wallet Identifier
items array Elements array
pagination object Pagination info

Element items:

Parameter Type Description
date string Date of the transfer
type string Item type: payment or receipt
txs array Array of transaction identifiers
id string Item identifier
is_confirmed boolean Item confirmation status
amount integer Item amount

Elements pagination:

Parameter Description
total Total number of history items
offset The sequence number of the element from which the counting starts. Default value: 0
limit Maximum number of items that request will return.
Default value: 10

# Success response example:

  {
      "wallet": "btc-f43a47823c6f0894c83e3e364fa12654",
      "items": [
      {
        "date": "2021-02-03T18:17:50.450469",
        "type": "receipt",
        "id": "bd1e0268f5e482146a7f672d37f2936c93088e499adbd0f428561321f48f2b97",
        "is_confirmed": true,
        "amount": 100000
      },
      {
        "date": "2021-02-02T06:20:01.623701",
        "type": "payment",
        "id": "6cc5842c7a2d9c236721726311a32ceb124f83c4553b999ae2bdda8c8cc43359",
        "is_confirmed": true,
        "amount": -20165
      }
      ],
      "pagination": {
        "total": 9,
        "offset": 0,
        "limit": 10
      }
  }

# Error Response

  • HTTP Status Code: 400 500
  • Content type: application/json

Playground

# Wallet History Item

The detailed information of the wallet history item contains the list of transactions, the fees, and the list of incoming/outgoing addresses.

# Request

  • HTTP Method: GET
  • URL: https://apirone.com/api/v2/wallets/{wallet}/history/{HistoryItemID}
Parameter Type Description Required
wallet string Wallet Identifier
HistoryItemID string Identifier of the history item

# Request Example

curl 'https://apirone.com/api/v2/wallets/btc-c70afacf0b7d7808e8be36bfd7ceed71/history/11e5c2c2be8f966444f739d4dabbfb461bca991ef6ab7a6dcea7b1e2237eee31'

# Success Response Reference

  • HTTP Status Code: 200
  • Content Type: application/json
Parameter Type Description
wallet string Wallet Identifier
created string Item creation date
type string Item type: outgoing payment or incoming receipt
id string Item identifier
txs array List of associated transactions
destinations array Destinations array
amount integer Item amount
total integer Total transfer amount. Includes all fees and transfer amount
fee object Network fee strategy
  {
    "wallet": "btc-c70afacf0b7d7808e8be36bfd7ceed71",
    "created": "2022-03-10T16:08:55.527229",
    "type": "receipt",
    "id": "11e5c2c2be8f966444f739d4dabbfb461bca991ef6ab7a6dcea7b1e2237eee31",
    "items": [
        {
            "txid": "11e5c2c2be8f966444f739d4dabbfb461bca991ef6ab7a6dcea7b1e2237eee31",
            "address": "2N23qomMWbx2U5omkmfpgDyWzY7nBCVZJih",
            "amount": 2611,
            "block": {
                "hash": "0000000000000384a22213721275ebbfd07bc0c89dc18c30dabf5e33a1ee9c47",
                "height": 2187854,
                "deleted": false
            },
            "is_confirmed": true
        },
        {
            "txid": "11e5c2c2be8f966444f739d4dabbfb461bca991ef6ab7a6dcea7b1e2237eee31",
            "address": "2N6i5p9VSrKxLNR2hRyNiLmdmmtaMUDYH9q",
            "amount": 7980,
            "block": {
                "hash": "0000000000000384a22213721275ebbfd07bc0c89dc18c30dabf5e33a1ee9c47",
                "height": 2187854,
                "deleted": false
            },
            "is_confirmed": true
        }
    ],
    "amount": 10591
  }

# Error Response

  • HTTP Status Code: 400 500
  • Content Type: application/json

Playground

# Address History

Outputs a list of operations of a specified wallet address.

# Request

  • HTTP Method: GET
  • URL: https://apirone.com/api/v2/wallets/{wallet}/addresses/{address}/history
Parameter Type Description Required
wallet string Wallet Identifier
address string Cryptocurrency wallet address
offset integer The sequence number of the item from which the counting starts.
Default value: 0
limit integer The maximum number of transactions displayed on the page.
Default value: 10

# Request Example

curl 'https://apirone.com/api/v2/wallets/btc-c70afacf0b7d7808e8be36bfd7ceed71/addresses/35Gnk75DbehHXkshBX1QzpKdq4AJDW6KKv/history?limit=10&offset=0'

# Success Response Reference

  • HTTP Status Code: 200
  • Content Type: application/json
Parameter Type Description
wallet string Wallet Identifier
address string Cryptocurrency wallet address
txs array Contains information about transactions by address from the blockchain
pagination object Pagination info

Elements of txs:

Parameter Type Description
txid string Identifier of the transaction in the blockchain
created string Timestamp of the block with the transaction
amount integer Transfer amount
block object Contains data about the block:
hash - hash of the block
height - height of the block. If the height of the block is 1, then the transaction is in the mempool and has never been confirmed.

Elements {pagination}:

Parameter Description
total Total number of items
offset The sequence number of the element from which the counting starts.
Default value: 0
limit Maximum number of items that request will return.
Default value: 0

# Response example

{
      "wallet": "btc-c70afacf0b7d7808e8be36bfd7ceed71",
      "address": "35Gnk75DbehHXkshBX1QzpKdq4AJDW6KKv",
      "txs": [ {
        "txid": "48563c8ad8339798bc0f6d7ee0fe3f42f5721e5f989269d035ba9be0e2fd8658",
        "created": "2021-01-12T18:15:10.237846",
        "amount": 115182,
        "block": {
          "hash": "0000000000000011715d6663ac65435623c22d8920853bc861178de792ba0732",
          "height": 1903704,
          "deleted": false
        },
        "deleted": false
      } ],
      "pagination": {
        "limit": 10,
        "offset": 0,
        "total": 1
      }
    }

# Error Response

  • HTTP Status Code: 400 500
  • Content Type: application/json

Playground

# Wallet Callback Info

Outputs information on the saved callback for a specified address. Authorization is required.

# Request

  • HTTP Method: GET
  • URL: https://apirone.com/api/v2/wallets/{wallet}/callback
Parameter Type Description Required
wallet string Wallet Identifier
transfer-key string Key for accessing protected endpoints *

* transfer-key is required unless access token is applied

# Request example

curl 'https://apirone.com/api/v2/wallets/btc-f43a47823c6f0894c83e3e364fa12654/callback?transfer-key=oAqmClPQ69a2upN83N5XoPCBeH3XID41'

# Success Response Reference

  • HTTP Status Code: 200
  • Content Type: application/json
Parameter Type Description
wallet string Wallet Identifier
callback object Callback url and data
    {
      "wallet": "btc-f43a47823c6f0894c83e3e364fa12654",
      "callback": {
        "method": "POST",
        "url": "http://example.com",
        "data": {
          "user": "john",
          "order": 123456
        }
      }
    }
    

# Error response

  • HTTP Status Code: 400 500
  • Content Type: application/json

Playground

# Address Callback Info

Outputs information on the saved callback for a specified address. Authorization is required.

# Request

  • HTTP Method: GET
  • URL:https://apirone.com/api/v2/wallets/{wallet}/addresses/{address}/callback
Parameter Type Description Required
wallet string Wallet Identifier
transfer-key string Key for accessing protected endpoints *
address string Cryptocurrency wallet address

* transfer-key is required unless access token is applied

# Request Example

curl 'https://apirone.com/api/v2/wallets/btc-f43a47823c6f0894c83e3e364fa12654/addresses/38cSD2nhmfVbXb9gRu8qVcLtyW6q8NVLQb/callback?transfer-key=oAqmClPQ69a2upN83N5XoPCBeH3XID41'

# Success Response Reference

  • HTTP Status Code: 200
  • Content Type: application/json
Parameter Type Description
wallet string Wallet Identifier
address string Cryptocurrency wallet address.
callback object A callback contains method, URL and user data

# Response example

    {
      "wallet": "btc-f43a47823c6f0894c83e3e364fa12654",
      "address": "38cSD2nhmfVbXb9gRu8qVcLtyW6q8NVLQb",
      "callback": {
        "method": "POST",
        "url": "http://example.com",
        "data": {
          "user": "john",
          "order": 123456
        }
      }
    }

# Error response

  • HTTP Status Code: 400 500
  • Content Type: application/json

Playground

# Address Callback Log

Return information about the Callback log in wallet. Authorization is required.

# Request

  • HTTP Method: GET
  • URL:https://apirone.com/api/v2/wallets/{wallet}/addresses/{address}/callback-log
Parameter Type Description Required
wallet string Wallet Identifier
transfer-key string Key for accessing protected endpoints *
address string Cryptocurrency address

* transfer-key is required unless access token is applied

# Request Example

curl 'https://apirone.com/api/v2/wallets/btc-c70afacf0b7d7808e8be36bfd7ceed71/addresses/35Gnk75DbehHXkshBX1QzpKdq4AJDW6KKv/callback-log?transfer-key=H1raUEOCIzpTxjFVlVvqR1qVlVlMsi76' 

# Success Response Reference

  • HTTP Status Code: 200
  • Content Type: application/json
Parameter Type Description
wallet string Wallet Identifier
address string Cryptocurrency address

Callback data log:

Parameter Type Description
date string Date of query to the client
request object Request from Processing to client
response object Response from client to processing

Request from the Processing to the client {request}:

Parameter Type Description
method string HTTP method
url string Callback URL
wallet string Wallet Identifier
args object Request parameters. Consists of required fields by provider:
wallet: wallet id.
value: amount in wallet units.
input_address: payment address.
confirmations: the number of confirmations in the network.
input_transaction_hash: transaction hash

Response from the client to the Processing {response}:

Parameter Type Description
status integer HTTP status code
headers objects HTTP headers
content string Response body (only 4096 bytes included).

Elements {pagination}:

Parameter Description
total Total number of items
offset The sequence number of the element from which the counting starts
limit Maximum number of items that request will return

# Response example

    {
      "wallet": "btc-c70afacf0b7d7808e8be36bfd7ceed71",
      "address": "35Gnk75DbehHXkshBX1QzpKdq4AJDW6KKv",
      "log": [ {
        "date": "2021-01-28T06:52:37.263Z",
        "request": {
          "method": "string",
          "url": "string",
          "args": {
            "wallet": "btc-c70afacf0b7d7808e8be36bfd7ceed71",
            "value": 46113216,
            "input_address": "3QSx5y7g5DZojZbGTsNSNJ5kPBTF56h6Kz",
            "confirmations": 0,
            "input_transaction_hash": "7f7a9f74dc566aabd0df5344a552c51b2f55de8fea6a1496f627918497300d54"
          }
        },
        "response": {
          "status": 200,
          "headers": {
            "Date": "Mon, 18 Feb 2021 13:57:20 GMT",
            "Server": "Apache",
            "X-Powered-By": "PHP/7.4.10",
            "Expires": "Thu, 19 Nov 1981 08:52:00 GMT",
            "Cache-Control": "no-store, no-cache, must-revalidate",
            "Pragma": "no-cache",
            "Access-Control-Allow-Origin": "*",
            "Connection": "keep-alive",
            "Content-Length": "3",
            "Content-Type": "text/html; charset=UTF-8"
          },
          "content": "*ok*"
        }
      } ],
      "pagination": {
        "total": 2,
        "offset": 0,
        "limit": 10
      }
    }

# Error response

  • HTTP Status Code: 400 500
  • Content Type: application/json

Playground