Skip to main content
POST
/
api
/
v1
/
breezee
/
receive-payment
Receive Payment
curl --request POST \
  --url https://usebreezee.xyz/api/v1/breezee/receive-payment \
  --header 'Content-Type: application/json' \
  --header 'X-API-Key: <api-key>' \
  --data '
{
  "amount_sats": 123,
  "description": ""
}
'
{
  "detail": [
    {
      "loc": [
        "<string>"
      ],
      "msg": "<string>",
      "type": "<string>"
    }
  ]
}

Responses

200: Success

{
  "status": true,
  "payment_request": "lnbc10u1p3...",
  "fee_sats": 0
}

422: Validation Error

{
  "detail": "Node error"
}

Authorizations

X-API-Key
string
header
required

Body

application/json
amount_sats
integer
required
description
string | null
default:""

Response

Successful Response