api.md

fuse-funder v0.2.0

Fuse Funder API. Base url: https://funder-qa.fuse.io/api

• Bonus

  • Fetch token funding status
  • Bonus account with token

• Funding

  • Fund account with native
  • Fetch native funding status
  • Fetch token funding status
  • Fund account with token
  • Fetch native balance
  • Fetch token balance

• Job

  • Fetch job by id

Bonus

Fetch token funding status

Back to top

GET /bonus/status/:id

Parameter Parameters

Name	Type	Description
id	String	Token bonus id

Success 200

Name	Type	Description
status	String	Token bonus status, can be STARTED, SUCCEEDED or FAILED.

Bonus account with token

Back to top

POST /bonus/token

Parameter Parameters

Name	Type	Description
phoneNumber	String	Phone number of bonus receiver
accountAddress	String	Account address to give bonus
tokenAddress	String	Token address of the token to give as bonus
bonusInfo	Object	The reason for the bonus
originNetwork	Object	ropsten/mainnet

Success 200

Name	Type	Description
id	String	Task id of the bonus job
status	String	Current status of the job. Should be "STARTED" if all good.

Funding

Fund account with native

Back to top

POST /fund/native

Parameter Parameters

Name	Type	Description
accountAddress	String	Account address to fund
tokenAddress	String	Token address to determine the bonus amount (optional)

Success 200

Name	Type	Description
id	String	Task id of the funding job
status	String	Current status of the job. Should be "STARTED" if all good.

Fetch native funding status

Back to top

GET /fund/status/:id

Parameter Parameters

Name	Type	Description
id	String	Native funding id

Success 200

Name	Type	Description
status	String	Native funding status, can be STARTED, SUCCEEDED or FAILED.

Fetch token funding status

Back to top

GET /fund/status/:id

Parameter Parameters

Name	Type	Description
id	String	Token funding id

Success 200

Name	Type	Description
status	String	Token funding status, can be STARTED, SUCCEEDED or FAILED.

Fund account with token

Back to top

POST /fund/token

Parameter Parameters

Name	Type	Description
phoneNumbber	String	Phone number of bonus receiver
accountAddress	String	Account address to fund
tokenAddress	String	Token address of the funding token
originNetwork	Object	ropsten/mainnet

Success 200

Name	Type	Description
id	String	Task id of the funding job
status	String	Current status of the job. Should be "STARTED" if all good.

Fetch native balance

Back to top

GET /balance/native/:accountAddress

Parameter Parameters

Name	Type	Description
accountAddress	String	Account address

Success 200

Name	Type	Description
balance	String	Native balance

Fetch token balance

Back to top

GET /balance/token/:accountAddress/:tokenAddress

Parameter Parameters

Name	Type	Description
accountAddress	String	Account address

Success 200

Name	Type	Description
balance	String	Token balance

Job

Fetch job by id

Back to top

GET /job/:id

Parameter Parameters

Name	Type	Description
id	String	Job id

Success 200

Name	Type	Description
data	Object	Job object