Short API documentation

Request extension may be html, json, xml. Default is html.

Common Parameters

  • SHOP_ID - ID of the your shop on our service
  • CURR - abbreviation of currency. For example BTC, USD, AUD, LTC
  • ADDR - cryptocurrency address
  • BILL_ID - ID of the bill (invoice) on our service
  • BILL_ID_SECR - bill_id with secret key. For example 1234.w3rX1daK
  • ORDER_ID - ID of the order in your shop
  • PRICE - The price of the order
  • TX_ID - Transaction ID
  • STATUS - NEW, FILL, SOFT, HARD, TRUE, CLOSED, EXPIRED, INVALID - see documentation

Automatic Registration

quick_reg

Simple registration of your shop in our service. If not set shop_url then callback will not work and for check a payments need call the [check] function from API. It will return a SHOP_ID. If SHOP_ID < 0 then that ADDR already registered - use another ADDR for change registration parameters

Arguments

  • ADDR

Variables

  • shop_url=URL - For example http://lite.cash/bets
  • icon_url=PATH - For example images/logo1.png
  • note_url=PATH - Service will note to that path with bill_id=BILL_ID&order_id=ORDER_ID. For example callback/for_litecash?
  • back_url=PATH - For example orders/show?&order_id=
  • email=EMAIL
  • note_on=STATUS - Note on bill status: SOFT|HARD|TRUE
  • show_text=TEXT - Show this text for all bills

http://lite.cash/api/quick_reg.json/14qZ3c9WGGBZrftMUhDTnrQMzwafYwNiLt?email=..&shop_url=http://my_shop.com/shop1&note_url=callback/for_litecash?&...

Make the bill (invoice)

make

url PATH: api_bill
Making bill for your order.
It will return [BILL_ID].[secret key] or [BILL_ID] if the bill is public.
Then redirect customer to bill url http://lite.cash/bill/show/[BILL_ID_SECR]

Arguments

  • shop_id - ID of yor shop in our service

Variables

  • price=PRICE - If price = 0 or not setted - make an deposit bill
  • curr=CURR - Currency for price. Default = BTC
  • conv_curr=CURR - Conver all payments in that CURR
  • order=... - If order not specified then it random generated
  • keep=0.001 .. 1 - Not withdraw a payments for this bill - keep them on service for using later
  • public - Set that bill as public. For example ...curr=USD&public&price=...
  • expire=INT - Expire bill in minutes. Max = 144000 . Default is 180
  • exchanging - This bill is for exchanging
  • mess= - Any message
  • lang= - Set a default languege for that bill. For example ...&lang=fr...
  • not_convert - If setted then without payments convertion. For example ...curr=BTC&not_convert&price=...
  • curr_in=CURR - Ony that CURR(s) accepted. For example ...&curr_in=BTC&curr_in=LTC...
  • curr_in_stop=CURR - That CURR(s) not accepted. For examplle ...curr_in_stop=LTC&curr_in_stop=PPC..
  • back_url=PATH - If set override a shop [back_url] for this bill
  • note_on=STATUS - If set override a shop [note_on] for this bill
  • vol_default=FLOAT - Default volume for orders without PRICE
  • email=EMAIL

http://lite.cash/api_bill/make.json/113?price=123&curr=USD&public&mess=HI

Show the bill (invoice) to customer

show

url PATH: bill
When Your obtain BILL_ID or BILL_ID_SECR you may show bill (invoice) to customer

Arguments

  • BILL_ID | BILL_ID_SECR

http://lite.cash/bill/show/334.r4GsW2hs2

Check the bill

check

url PATH: api_bill
Checking bill for your order

Arguments

  • BILL_ID | BILL_ID_SECR

Variables

  • status - SOFT, FILL, HARD

http://lite.cash/api_bill/check.json/354?status=HARD

check_note

url PATH: api_bill
Start check a note to your shop as if bill status is changed - for development and tests.

Arguments

  • BILL_ID | BILL_ID_SECR

http://lite.cash/api_bill/check_note.json/334.r4GsW2h4

check_txid

url PATH: api_bill
Chech TX_ID for accept as payment if it not accepted by some error

Arguments

  • CURR
  • TX_ID

http://lite.cash/api_bill/check_txid/BTC/4c921...

Get the bill info

info

url PATH: api_bill
Get full bill info for your order

Arguments

  • BILL_ID | BILL_ID_SECR

Variables

  • get_addrs - Show payments ADDR
  • all_fields - All fields
  • get_payouts - Get payouts
  • curr=CURR - Filter by CURR
  • from=DATETIME - Filter
  • till=DATETIME - Filter
  • start_rec=INT - Start from N-payment
  • recs=INT - Get limit payments
  • last=INT - Get last N payments for each CURR

http://lite.cash/api_bill/info.json/334.r4GsW2h4?curr=BTC&get_payouts&last=20&from=2014-01-31 20:57:02

get_addr

url PATH: api_bill
Get cryptocurrency address for the bill

Arguments

  • BILL_ID | BILL_ID_SECR
  • CURR

http://lite.cash/api_bill/get_addr.json/334.r4GsW2h4/BTC

Other

bill_rates

Get rates for the currency on volume

Arguments

  • CURR
  • volume - For that volume

http://lite.cash/api/bill_rates.json/BTC/0.5

curr_get_info

Arguments

  • CURR

http://lite.cash/api/curr_get_info.json

get_balances

Get balances for the shop

Arguments

  • SHOP_ID

http://lite.cash/api/get_balances.json

get_reserves

Get reserves on our service. For exhange

Arguments

  • negative

http://lite.cash/api/get_reserves.json

get_shops_reserves

Get reserves for shops on our service.

It good if all = 0

http://lite.cash/api/get_shops_reserves.json

tx_info

Get transaction info

Arguments

  • CURR
  • TX_ID

http://lite.cash/api/tx_info.json

tx_senders

Get senders info for the transaction

Arguments

  • CURR
  • TX_ID

http://lite.cash/api/tx_senders.json

validate_addr

Validate cryptocurrency address

Arguments

  • ADDR

http://lite.cash/api/validate_addr.json

withdrawal_info

Get withdrawal info:

Minimal limit for payout

http://lite.cash/api/withdrawal_info.json

How it work

  • Register on service with setting [shop_url] and [note_url] - http://lite.cash/api/quick_reg/[ADDR]?shop_url=...
  • Make a bill by request a [make] API function and receive the BILL_ID or BILL_ID_SECR - http://lite.cash/api_bill/make/[SHOP_ID]?price=...
  • Show to customer a bill by call a [show] url - http://lite.cash/bill/show/[BILL_ID]
  • Service will notify to [shop_url]/[note_url] when customer will pay that bill
  • Check a status of a bill by call a [check] API function, when our service notify your shop - http://lite.cash/api_bill/check/[BILL_ID]
  • Set a order status to "payed" if a status of the bill is SOFT or HARD or CLOSED - we recommend waiting a HARD status