API Reference

Add Invoice with a mSat amount

post
https://api-sandbox.poweredbyibex.io/invoice/add

Add invoice.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Body Params
int32

Amount of the invoice in the currency of the account. Can be 0 for amount less or need to be more than a sat.

string
required

The account that will create the invoice. This account will be credited if someone pay the invoice.

string

(Optional) Maximum 50 chars.

int32
Defaults to 900

(Optional) How long before the invoice expire in seconds. Maximum: 15 mins.

string

(Optional) Webhook invocation when invoice is paid A /POST with the following body is made to webhookUrl { hash: String, receivedMsat: Int, settledAtUtc: String, webhookSecret: String // omitted if empty }

string

(Optional) A string used to validate the webhook comes from IBEXHub. Don't trust, verify.

Responses

Updated 6 months ago

Language
Credentials
Header
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json

Updated 6 months ago