Get History

Retrieve the funding transaction history for your prepaid API Key account.

GET https://api2.sms4sats.com/history

Returns the complete funding history for a prepaid API Key, including all top-up transactions and their amounts.

Headers

Name	Type	Required	Description
X-API-Key	String	Yes	Your API Key.

200: OK

{
  status: 'OK', 
  totalAmount: 349500,
  orders: [ 
    {
      amount: 9500,
      createdAt: 1668612831730,
      desc: 'fund account',
      description: 'fund account',
      holdinvoice: true,
      preimage: 'xxx',
      preimageHash: 'sha256(xxx)',
      price: 9500,
      userId: 'APIKEY'
    },
    ...
  ],
}

400: Bad Request

Response Fields

Field	Type	Description
status	String	OK on success
totalAmount	Number	Total satoshis funded across all transactions
orders	Array	List of funding transactions
orders[].amount	Number	Amount funded in this transaction (satoshis)
orders[].createdAt	Number	Unix timestamp (milliseconds) of the transaction
orders[].description	String	Transaction description
orders[].holdinvoice	Boolean	Whether this was a hold invoice
orders[].preimage	String	Lightning payment preimage
orders[].preimageHash	String	SHA256 hash of the preimage
orders[].price	Number	Price paid (satoshis)
orders[].userId	String	The API Key associated with this transaction

Get in touch for volume discounts: [email protected].