Sign in
Payments

List payments

Changed on

Returns all the payments given a filter

get/v1/payments

Request

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

Query parameters

limitinteger nullable

Total amount of results to return

offsetinteger nullable

Offset where to start returning results

idsstring[] nullable

List of IDs

wallet_idstring uuid nullable

Wallet ID. Automatically populated with your ID

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

Lifecycle status of a payment.

Status

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

The ledger a transaction settles on.

Ledger

ln_addressesstring[] nullable

Lightning addresses

btc_addressesstring[] nullable

Bitcoin addresses

order_direction'Asc' | 'Desc'

Direction of result ordering for list endpoints.

Direction of the ordering of results

Response

Success

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 new optional query request parameter btc_addresses

    • info

      added the new optional query request parameter ln_addresses

    • 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