Sign in
Payments

Find a payment

Changed on

Returns the payment by its ID.

get/v1/payments/{id}

Request

  • The document declares no server URL.
  • Auth: HTTP bearer

Path parameters

idstring uuid required

Response

Found

amount_msatinteger required

Amount in millisatoshis.

created_atstring date-time required

Date of creation in database

descriptionstring nullable

Description

errorstring nullable

Error message

fee_msatinteger nullable

Fees paid. Populated when a new channel is opened to receive the funds

idstring uuid required

Internal ID

ledger'Lightning' | 'Internal' | 'Onchain' required

The ledger a transaction settles on.

payment_timestring date-time nullable

Payment time

status'Pending' | 'Settled' | 'Failed' required

Lifecycle status of a payment.

updated_atstring date-time nullable

Date of update in database

wallet_idstring uuid required

Wallet ID

Example response

{
  "error": "failed to pay error message",
  "internal": {
    "btc_address": "bc1q...",
    "ln_address": "hello@numeraire.tech",
    "payment_hash": "b587c7f76339e3fb87ad2b..."
  },
  "lightning": {
    "ln_address": "hello@numeraire.tech",
    "payment_hash": "b587c7f76339e3fb87ad2b..."
  }
}

Changes

  • d0b29ec67614Revision changes
    • breaking

      removed the required property from the response with the status

  • c3abc288bbc3Revision changes
    • warning

      removed the optional property from the response with the status

    • warning

      removed the optional property from the response with the status

    • warning

      removed the optional property from the response with the status

    • warning

      removed the optional property from the response with the status

    • warning

      removed the optional property from the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status