Sign in

v1

latestOpenAPI 3.1.02026-07-241653251.3 MB
Deposits

Create a BOLT11 invoice for deposit

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

post/deposits/bolt11

Headers

X-SCX-SIGNEDstring required

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

X-SCX-TIMESTAMPstring required
Example:1678901234

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

Request body

amountstring required

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

participant_codestring required

The participant code to have the deposit credited to

account_labelstring

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

test_modeboolean

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'deposit' | 'withdrawal'

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.

test_memostring

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

Example request

{
  "amount": "1.00000001",
  "participant_code": "CUST01",
  "account_label": "general",
  "test_mode": true,
  "test_type": "deposit",
  "test_memo": "invoice_test_12345"
}

Response

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

encoded_invoicestring required

The encoded BOLT11 invoice the payer should pay to credit the deposit.

expirationstring date-time required

The expiration timestamp in RFC3339 format.

Example response

{
  "encoded_invoice": "lnbcrt2u1pndp4y5pp5hgh2...",
  "expiration": "2026-05-04T12:45:00Z"
}