Skip to main content
GET
https://api.zebedee.io
/
v0
/
charges
/
{id}
Retrieve Charge
curl --request GET \
  --url https://api.zebedee.io/v0/charges/{id} \
  --header 'apikey: <apikey>'
{
  "success": true,
  "message": "Successfully retrieved Charge.",
  "data": {
    "unit": "msats",
    "amount": "10000",
    "confirmedAt": null,
    "status": "pending",
    "description": "My Charge Description",
    "createdAt": "2020-05-09T15:09:05.765Z",
    "expiresAt": "2020-05-09T15:14:05.618Z",
    "id": "1907b0fe-789b-4e25-b18a-0c4c0f5cced7",
    "internalId": "11af01d092444a317cb33faa6b8304b8",
    "callbackUrl": "https://your-website.com/callback",
    "invoice": {
        "request": "lnbc100n1p0td3u3pp5z2ed9yjfrz0rgu0fzuc5cdwfu8dtjlgrfztz5uga8hakkjy2yzgsdpzf4ujqsmgv9exwefqg3jhxcmjd9c8g6t0dccqzpgxqzfvsp5q8z5mkghmuzrnusxdwtmls7x8vuy63j25rt4z55gj3s7340dv72q9qy9qsqz02rlmlzcvew3vk90c6l0369ewk7tkr2tx0yrk3qa235v07w6d3qeksk99wm7y8f8ug7zqy6yjudu4cs2f4umpey43cw7msyj7uqj2qq8x03te",
        "uri": "lightning:lnbc100n1p0td3u3pp5z2ed9yjfrz0rgu0fzuc5cdwfu8dtjlgrfztz5uga8hakkjy2yzgsdpzf4ujqsmgv9exwefqg3jhxcmjd9c8g6t0dccqzpgxqzfvsp5q8z5mkghmuzrnusxdwtmls7x8vuy63j25rt4z55gj3s7340dv72q9qy9qsqz02rlmlzcvew3vk90c6l0369ewk7tkr2tx0yrk3qa235v07w6d3qeksk99wm7y8f8ug7zqy6yjudu4cs2f4umpey43cw7msyj7uqj2qq8x03te"
    }
  }
}

​
Usage

While the best approach is to rely on the callbackUrl property and expect async Charge updates sent from ZBD servers, this API can be used to check any information about any Charge, specifically properties such as status and internalId which are likely useful for your application.
For most use cases it is unlikely you will hit a rate limit, however it is recommended to avoid practices such as “long polling” especially if your server collectively “long polls” for multiple clients as this could cumulatively cause a rate limit to be reached.

​
Configuration

​
Path Parameters

​
id
string
required
Charge ID

​
Header Parameters

​
apikey
string
required
ZBD Project API Key
{
  "success": true,
  "message": "Successfully retrieved Charge.",
  "data": {
    "unit": "msats",
    "amount": "10000",
    "confirmedAt": null,
    "status": "pending",
    "description": "My Charge Description",
    "createdAt": "2020-05-09T15:09:05.765Z",
    "expiresAt": "2020-05-09T15:14:05.618Z",
    "id": "1907b0fe-789b-4e25-b18a-0c4c0f5cced7",
    "internalId": "11af01d092444a317cb33faa6b8304b8",
    "callbackUrl": "https://your-website.com/callback",
    "invoice": {
        "request": "lnbc100n1p0td3u3pp5z2ed9yjfrz0rgu0fzuc5cdwfu8dtjlgrfztz5uga8hakkjy2yzgsdpzf4ujqsmgv9exwefqg3jhxcmjd9c8g6t0dccqzpgxqzfvsp5q8z5mkghmuzrnusxdwtmls7x8vuy63j25rt4z55gj3s7340dv72q9qy9qsqz02rlmlzcvew3vk90c6l0369ewk7tkr2tx0yrk3qa235v07w6d3qeksk99wm7y8f8ug7zqy6yjudu4cs2f4umpey43cw7msyj7uqj2qq8x03te",
        "uri": "lightning:lnbc100n1p0td3u3pp5z2ed9yjfrz0rgu0fzuc5cdwfu8dtjlgrfztz5uga8hakkjy2yzgsdpzf4ujqsmgv9exwefqg3jhxcmjd9c8g6t0dccqzpgxqzfvsp5q8z5mkghmuzrnusxdwtmls7x8vuy63j25rt4z55gj3s7340dv72q9qy9qsqz02rlmlzcvew3vk90c6l0369ewk7tkr2tx0yrk3qa235v07w6d3qeksk99wm7y8f8ug7zqy6yjudu4cs2f4umpey43cw7msyj7uqj2qq8x03te"
    }
  }
}