Tallycoin API Docs
1.0
4
API Server

introduction

1

start here

REFERENCE

PARAMETERS
 
Request
https://api.tallyco.in/v1
Response
200
BODY
API v1 and v2 HAVE BEEN DEPRECATED

New API available! Please visit https://tallycoin.app/api/ for more information.

fundraiser

1
POST

fundraiser

REFERENCE

DEPRECATED

PARAMETERS
fundraiser_id string Unique ID of the fundraiser eg, https://tallyco.in/s/{fundraiser_id}/.
exclude_exchange_rate string Exclude exchange rate information from the response.
/
fundraiser
/
 
Request
POST https://api.tallyco.in/v1
Response
200
BODY
											{
	"goal_value":"1000",
	"goal_denomination":"usd",
	"goal_is_monthly":"N",
	"goal_percentage":"7.12",
	"satoshis_received":1240690,
	"denom_value_received":"71.18",
	"lightning_available":"Y",
	"fundraiser_url":"https:\/\/tallyco.in\/s\/servers",
	"fundraiser_owner_handle":"djbooth007",
	"fundraiser_owner_name":"Dj Booth",
	"fundraiser_owner_avatar":"https:\/\/avatars.io\/twitter\/djbooth007\/",
	"fundraiser_title":"TALLY COIN SERVERS",
	"fundraiser_time_left":2232142,
	"exchange_rate":
		{"SAT":{"rate":"1","name":"Bitcoin (Satoshis)","symbol":"SAT"},
		"BTC":{"rate":"0.00000001","name":"Bitcoin","symbol":"BTC"},
		"USD":{"rate":5736.8733,"name":"United States Dollar","symbol":"$"},
		"GBP":{"rate":4368.4569,"name":"British Pound Sterling","symbol":"£"},
		"EUR":{"rate":5127.0724,"name":"Euro","symbol":"€"},
		"AUD":{"rate":8224.5136,"name":"Australian Dollar","symbol":"$"},
		"CAD":{"rate":7731.2285,"name":"Canadian Dollar","symbol":"$"},
		"CHF":{"rate":5828.3994,"name":"Swiss Franc","symbol":"₣"},
		"CNY":{"rate":40202.5,"name":"Chinese Yuan","symbol":"¥"},
		"HKD":{"rate":45011.5667,"name":"Hong Kong Dollar","symbol":"$"},
		"ILS":{"rate":20554.9309,"name":"Israeli New Sheqel","symbol":"₪"},
		"INR":{"rate":397931.7286,"name":"Indian Rupee","symbol":"₹"},
		"JPY":{"rate":634268.702,"name":"Japanese Yen","symbol":"¥"},
		"KRW":{"rate":6728444.8289,"name":"South Korean Won","symbol":"₩"},
		"NOK":{"rate":50185.3206,"name":"Norwegian Krone","symbol":"kr"},
		"NZD":{"rate":8678.4265,"name":"New Zealand Dollar","symbol":"$"},
		"RON":{"rate":24323.7647,"name":"Romanian Leu","symbol":"lei"},
		"RUB":{"rate":375224.7893,"name":"Russian Ruble","symbol":"₽"},
		"SAR":{"rate":21515.5703,"name":"Saudi Riyal","symbol":"﷼"},
		"SEK":{"rate":54910.3948,"name":"Swedish Krona","symbol":"kr"},
		"SGD":{"rate":7828.8242,"name":"Singapore Dollar","symbol":"$"},
		"THB":{"rate":183465.2063,"name":"Thai Baht","symbol":"฿"},
		"TRY":{"rate":34361.0028,"name":"Turkish Lira","symbol":"₤"},
		"VEF":{"rate":1425542119.1645,"name":"Venezuelan Bol\u00edvar Fuerte","symbol":"Bs"},
		"XAU":{"rate":4.4725,"name":"Gold (troy ounce)","symbol":"$"},
		"XAG":{"rate":385.9453,"name":"Silver (troy ounce)","symbol":"$"},
		"ZAR":{"rate":83141.1899,"name":"South African Rand","symbol":"R"}},
		"exchange_rate_CREDIT":"This data was produced from the CoinDesk Bitcoin Price Index (USD)."
	}
What to expect from the response

"goal_value": the amount being raised, either a fiat currency or satoshis (100 millionth of a bitcoin).
"goal_denomination": fiat currency (eg, "usd") or btc.
"goal_is_monthly": either "Y" or "N".
"goal_percentage": percentage of amount raised towards the goal.
"satoshis_received": the number of satoshis received.
"denom_value_received": when goal_denomination is fiat, satoshis_received is used to converted to fiat.
"lightning_available": either "Y" or "N".
"fundraiser_url": full URL to the fundraiser.
"fundraiser_owner_handle": username of user raising funds.
"fundraiser_owner_name": full name of user raising funds.
"fundraiser_owner_avatar": avatar image for the user raising funds.
"fundraiser_title": title designated by the user raising funds.
"fundraiser_time_left": number of seconds remaining until fundraiser ends or is reset.
"exchange_rate": additional data for currency conversion.

payment

2
POST

payment/request

REFERENCE

DEPRECATED

PARAMETERS
type string Either 'fundraiser' or 'profile'.
id string Unique ID of a fundraiser or a user's username.
satoshi_amount number An amount to be paid, in satoshis.
payment_method string Either 'btc' or 'ln'.
/
payment
/
request
/
 
Request
POST https://api.tallyco.in/v1
Response
200
BODY
											{
		"lightning_pay_request":"lnbc42200u1pw243kj...h8epmf",
		"lightning_invoice_id":"ch_ZZZ111222444555666777",
		"btc_address":"3Z7vTgDnGdfZZZZZZZZZZZWZqsCHhkKMu2",
		"cost":1000,
		"tc_payment_id":"pwrvjglhee"
		}
What to expect from the response when payment_method=ln (lightning)

"lightning_pay_request": The invoice payment request.
"lightning_invoice_id": External provider's invoice ID.
"btc_address": A bitcoin address (if provided by user). Can be used as fallback if lightning fails.
"cost": The number of satoshis to be sent.
"tc_payment_id": Internal Tallycoin payment ID. Required for calling /payment/verify/.

What to expect from the response when payment_method=btc (bitcoin on-chain)

"btc_address": A bitcoin address.
"cost": The number of satoshis to be sent.
"tc_payment_id": Internal Tallycoin payment ID for verification of payment.
POST

payment/verify

REFERENCE

DEPRECATED

PARAMETERS
payment_id string Tallycoin Payment ID. Provided when calling /payment/request/.
/
payment
/
verify
/
 
Request
POST https://api.tallyco.in/v1
Response
200
BODY
											{
"tc_payment_id":"ctlvfs9e6v",
"payment_state":"unpaid"
}
What to expect from the response for a lightning payment request

"tc_payment_id": Confirmation of Tallycoin Payment ID
"satoshi_amount": Amount payable in satoshis
"payment_state": Either 'unpaid' or 'paid'.