Wallex Pay
Sign InSign Up
  • Welcome
  • Product Introduction
  • Get Started
  • Integration Guide
  • Account Creation
    • Individual/Freelance Account
    • Business Account
  • Verification Process
    • Need Assistance?
      • Starting Point
      • Common Rejection Causes
      • Proof of Address (POA)
      • Pending Verification
      • Session Expired?
  • Supported Coins
  • Merchant Tools
    • Payment Buttons
    • Custom APIs
      • API Basics
      • Informational Commands
      • Receiving Payments
      • Withdrawals/Transfers
    • Instant Payment Notification (IPN)
    • Invoice Builder
    • Point of Sale (POS)
    • Pre-Built Plugins
  • Mass Payouts
  • API Keys Management
  • Integration Testing & Testnet
  • Profile Management
    • Manage Personal Info
    • Wallet Statement
  • Access Issues
    • Why my Account is Blocked/Suspended?
  • Security
    • Account Security
    • Two-Factor Authentication (2FA)
    • Hacked Account
  • Fees & Limits
  • Legal & Regulatory
    • Restricted Jurisdictions
    • User Agreement
    • Privacy Policy
  • Contact our Experts
Powered by GitBook
On this page
  1. Merchant Tools
  2. Custom APIs

Informational Commands

PreviousAPI BasicsNextReceiving Payments

Last updated 9 months ago

Get Basic Account Information


API POST Fields

In addition to the described in the API Basics >

Field Name
Description
Required?

cmd

get_basic_info

Yes

Method: POST URL:

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

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

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

Field Name
Description
Required?

cmd

get_deposit_address

Yes

currency

The currency the buyer will be sending.

No

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.

In addition to the described in the API Basics >

Method: POST URL:

In addition to the described in the API Basics >

Method: POST URL:

http://wallexpay.io/api/balances
http://wallexpay.io/api/get_deposit_address
http://wallexpay.io/api/get_basic_info
Main Fields
Introduction
Main Fields
Introduction
Main Fields
Introduction