Skip to main content
Informational Commands
Updated over a month ago

Get Basic Account Information


API POST Fields

In addition to the Main Fields described in the API Basics > Introduction

Field Name

Description

Required?

cmd

get_basic_info

Yes

Method: POST


API Response

A successful call to get the 'get_basic_info' command will give you a result similar to this (JSON):

{
"error": "ok",
"result": {
"username": "Username",
"merchant_id": "User's Merchant ID",
"email": "account@email.com",
"public_name": "Account's Public Name" // May be blank if not set!!!
}
}

Get Coin Balances


API POST Fields

In addition to the Main Fields described in the API Basics > Introduction

Field Name

Description

Required?

cmd

balances

Yes

all

If set to 1, the response will include all coins, even those with a 0 balance.

No

Method:

API Response

A successful call to the 'balances' command will give you a result similar to this (JSON):
{
"error": "ok",
"result": {
"BTC": {
"balance": 10000000,
"balancef": 0.10000000
}
}
}

Each coin will have the following fields:

  • balance = The coin balance as an integer in Sathosi

  • balancef = The coin balance as a floating point number.


Get Deposit Address


Addresses returned by this API are for personal use deposits and reuse the same personal address(es) in your wallet. Deposits to these addresses don't send IPNs. For commercial-use addresses and/or ones that send IPNs see 'get_callback_address'.

API POST Fields

In addition to the Main Fields described in the API Basics > Introduction

Field Name

Description

Required?

cmd

get_deposit_address

Yes

currency

The currency the buyer will be sending.

No

Method:

API Response

A successful call to the 'get_deposit_address' command will give you a result similar to this (JSON):

{
"error": "ok",
"result": {
"address": "1BitcoinAddress"
}
}

The result will have the following fields:

  • address = The address to deposit the selected coin into your Wallex Pay Wallet.

Did this answer your question?