Skip to main content
POST
/
api
/
v1
/
breezee
/
payments
Get Payments
curl --request POST \
  --url https://usebreezee.xyz/api/v1/breezee/payments \
  --header 'Content-Type: application/json' \
  --header 'X-API-Key: <api-key>' \
  --data '
{
  "filter": "SENT"
}
'
{
  "detail": [
    {
      "loc": [
        "<string>"
      ],
      "msg": "<string>",
      "type": "<string>"
    }
  ]
}
This endpoint retrieves a list of payments made on the node.

​
Request Body

​
filter
string
default:"SENT"
Filter payments by type. Options: SENT, RECEIVED.

​
Response

The response contains a list of payment objects.

​
200: Success

{
  "status": true,
  "payments": [
    {
      "id": "...",
      "payment_type": 0,
      "status": 0,
      "amount_msat": 10000,
      "fee_msat": 10,
      "timestamp": 1629345600,
      "details": {
          "type": "bolt11",
          "invoice": "..."
      }
    }
  ]
}

​
422: Validation Error

Standard validation error if the request body is invalid.

Authorizations

​
X-API-Key
string
header
required

Body

application/json
​
filter
string | null
default:SENT

Response

Successful Response