Settings

The following settings are available in wallets and accounts:

• the callback data
• destinations for forwarding
• processing fee policy

Authorization is required.

Request

• HTTP Method: PATCH
• Content Type: application/json
• URL for Account: https://apirone.com/api/v2/accounts/{account}
• URL for Wallet: https://apirone.com/api/v2/wallets/{wallet}

For Account

Parameter	Type	Description	Required
account	string	Account Identifier	✓
currency	string	Currency type (btc, ltc, bch, doge, trx, usdt@trx)	✓
processing-fee-policy	string	Processing fee plan. Processing-fee-policy may be fixed or percentage. More information see on Pricing page (opens new window) or Service info
callback	object	Callback data
destinations	array	Parameter of settings used for forwarding incoming funds to specified addresses; it contains addresses and amounts. Destination addresses shall either have values specified in percentage or be empty to be forwarded 100%

For Wallet

• URL: https://apirone.com/api/v2/wallets/{wallet}

Parameter	Type	Description	Required
wallet	string	Wallet Identifier	✓
processing-fee-policy	string	Processing fee plan. Processing-fee-policy may be fixed or percentage. More information see on Pricing page (opens new window) or Service info
callback	object	Callback data
destinations	array	Parameter of settings used for forwarding incoming funds to specified addresses; it contains addresses and amounts. Destination addresses shall either have values specified in percentage or be empty to be forwarded 100%

Request example (Account)

curl -X PATCH 'https://apirone.com/api/v2/accounts/apr-e729d9982f079fa86b10a0e3aa6ff37b' \
-H 'Content-Type: application/json' \
-d '{
   "currency": "btc",
   "transfer-key": "82ookirnTwWNXXqFwdOQMVZIamt8s1uT",
   "processing-fee-policy": "percentage",
   "callback": {
       "url": "https://example.com",
       "data": {
           "optional_key": "132534"
       }
   },
   "destinations": [
       {
           "address": "3JH4GWtXNz7us8qw1zAtRr4zuq2nDFXTgu",
           "amount": "100%"
       }
     ]
}'

Request example (Wallet)

curl -X PATCH 'https://apirone.com/api/v2/wallets/btc-f43a47823c6f0894c83e3e364fa12654' \
-H 'Content-Type: application/json' \
-d '{
  "transfer-key":"oAqmClPQ69a2upN83N5XoPCBeH3XID41",
  "processing-fee-policy": "fixed" 
   "callback": {
       "url": "https://example.com",
       "data": {
           "optional_key": "142534"
       }
   },
   "destinations": [
       {
           "address": "38cSD2nhmfVbXb9gRu8qVcLtyW6q8NVLQb",
           "amount": "100%"
       }
     ]
}'

Success Response Reference

• HTTP Status Code: 200
• Content Type: application/json

For Account

Parameter	Type	Description
account	string	Account Identifier
created	string	Account creation date
currency	string	Currency type
units	string	Cryptocurrency units. Units of all amount values for a specified account
processing-fee-policy	string	Processing fee plan
fee	string	Network fee strategy
fee-rate	integer	The parameter is only used when fee is set to "custom"
destinations	string	The cryptocurrency addresses of the store to which the payment will be forwarded
callback	object	Callback URL, method, and data

Response example

{
    "account": "apr-e729d9982f079fa86b10a0e3aa6ff37b",
    "currency": "btc",
    "created": "2020-08-25T18:35:29.468231",
    "units": "satoshi",
    "fee": "custom",
    "fee-rate": 1,
    "processing-fee-policy": "percentage",
    "destinations": [
      {
        "address": "3JH4GWtXNz7us8qw1zAtRr4zuq2nDFXTgu",
        "amount": "100%"
      }
    ],
    "callback": {
      "data": {
        "optional_key": "132534"
      },
        "method": "POST",
        "url": "https://example.com"
    }
  }

For Wallet

Parameter	Type	Description
wallet	string	Wallet Identifier
created	string	Wallet creation date
currency	string	Currency type
units	string	Cryptocurrency units. Units of all amount values for a specified wallet
destinations	string	The cryptocurrency addresses of the store to which the payment will be forwarded
fee	string	Network fee strategy
fee-rate	integer	The parameter is only used when fee is set to "custom"
callback	object	Callback URL, method, and data
processing-fee-policy	string	Processing fee plan

Response example

{
    "wallet": "btc-f43a47823c6f0894c83e3e364fa12654",
    "currency": "btc",
    "created": "2021-10-25T18:35:29.468231",
    "units": "satoshi",
    "fee": "custom",
    "fee-rate": 1,
    "processing-fee-policy": "fixed",
    "destinations": [
      {
        "address": "38cSD2nhmfVbXb9gRu8qVcLtyW6q8NVLQb",
        "amount": "100%"
      }
    ],
    "callback": {
      "data": {
        "optional_key": "142534"
      },
        "method": "POST",
        "url": "https://example.com"
    }
}

Error response

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