Create a BOLT11 invoice for deposit

post

https://api.cert.zerohash.com/deposits/bolt11

Creates a Lightning Network invoice (BOLT11) to deposit funds to the informed participant account.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Body Params

Details for creating a BOLT11 Lightning Network invoice, including participant code, amount, and description.

amount

string

required

The amount that should be deposited. Max precision of 8 decimals (one satoshi)

participant_code

string

required

The participant code to have the deposit credited to

account_label

string

The account_label associated with the participant account. This parameter is case sensitive.

test_mode

boolean

For CERT enviroiment, this flag indicates whether the invoice will be used internally to simulate a payment using our /deposits/bolt11/test_payment endpoint. If set to true, the invoice is not available to be payed at a external TESTNET lightning service.

test_type

string

enum

For CERT environment, this field indicates the type of test to be simulated. If test_mode is set to false, this field is ignored". If not provided, Default is deposit.

Allowed:

test_memo

string

For CERT environment, set a memo string to mark the test invoice. If test_mode is set to false, test_memo is ignored

Headers

X-SCX-SIGNED

string

required

HMAC-SHA256 signature of the request, base64-encoded. See the Authentication guide for the exact signing formula.

X-SCX-TIMESTAMP

string

required

Current Unix timestamp in seconds. Must be within 60 seconds of server time or the request is rejected.

Responses

200Successfully created BOLT11 Lightning Network invoice. Returns the created resource with generated IDs and timestamps.

400Bad Request

403Forbidden

404Not Found

500Internal Server Error

503Service Unavailable