Pay invoice.

❗️

Errors

Due to the nature of the lightning network, payments can in rare cases take some time to be settled.
In this case, this endpoint will return an error.
If this endpoint return an error (4XX or 5XX), do not consider the payment as failed [(unless it's a body parameter error (eg: wrong accountId, bad bolt11 ...)].

📘

Webhook

A POST call will be made to the webhookUrl when the payment change to SETTLED or FAILED .
The webhook will have the following body:

{
  "webhookSecret": string,
  "transaction": {
    "id": string,
    "createdAt": string,
    "accountId": string,
    "amount": int,
    "networkFee": int,
    "exchangeRateCurrencySats": int,
    "currencyID": int,
    "transactionTypeId": int,
    "payment": {
      "bolt11": string,
      "hash": string,
      "preImage": string,
      "memo": string,
      "amountMsat": int,
      "feeMsat": int,
      "paidMsat": int,
      "creationDateUtc": string,
      "settleDateUtc": string,
      "statusId": int,
      "failureId": int,
      "failureReason": {
        "id": int,
        "name": string,
        "description": string
      },
      "status": {
        "id": int,
        "name": string,
        "description": string
      }
    }
  }
}
Language
Authentication
Header
Click Try It! to start a request and see the response here!