Skip to main content

Transactions

Get Withdrawal​

GET

https://api.bitvora.com/v1/transactions/withdrawals/:withdrawalID

const axios = require('axios');
let data = '';

let config = {
  method: 'get',
  maxBodyLength: Infinity,
  url: 'https://api.bitvora.com/v1/transactions/withdrawals/0646abb1-68fe-43f2-8771-99a477a7c767',
  headers: { },
  data : data
};

axios.request(config)
.then((response) => {
  console.log(JSON.stringify(response.data));
})
.catch((error) => {
  console.log(error);
});


{
    "status": 200,
    "message": "Bitcoin withdrawal fetched successfully",
    "data": {
        "id": "0646abb1-68fe-43f2-8771-99a477a7c767",
        "company_id": "6fc6625d-b913-41cb-9096-d442ba2e567b",
        "ledger_tx_id": "921764e0-8fa4-4e85-a2b8-9f555cc17ea0",
        "amount_sats": 21000,
        "recipient": "tb1pj5mfgkhpjtuxyugrzufp3sy8c4nxy45ez227paehlavkys0yn7gs5l8538",
        "network_type": "signet",
        "rail_type": "on_chain",
        "status": "settled",
        "lightning_payment": null,
        "chain_tx_id": "3e19c5812dcae977dbbc02b2291a893a8aa2ba5572fa23a523cdd330fcf77b4b",
        "created_at": "2024-07-11T15:08:30.494359Z",
        "updated_at": "2024-07-11T15:08:30.494359Z"
    }
}

Get Lightning Invoice​

GET

https://api.bitvora.com/v1/bitcoin/deposit/lightning-invoice/:invoiceID

const axios = require('axios');

let config = {
  method: 'post',
  maxBodyLength: Infinity,
  url: 'https://api.bitvora.com/v1/bitcoin/deposit/lightning-invoice/:invoiceID',
  headers: {
    'Authorization': 'Bearer YOURAPIKEY',
    'Content-Type': 'application/json'
  }
};

axios.request(config)
.then((response) => {
  console.log(JSON.stringify(response.data));
})
.catch((error) => {
  console.log(error);
});

{
    "status": 200,
    "message": "Lightning invoice fetched successfully",
    "data": {
        "id": "25341452-ef46-4f74-b62d-041be72863f5",
        "node_id": "signet4.bitvora.com",
        "memo": "this est description",
        "r_preimage": "f668dcd4fc5a44c5b50a4f241147a444c7d1e3d2cff741919ee78165f7bc9f5c",
        "r_hash": "d8398d0f365eff27fac5bd44fbbca377aa43815f4fb8aef5c2c8690b9ce05121",
        "amount_sats": 1839,
        "settled": true,
        "payment_request": "lntbs18390n1pndmmsppp5mquc6rektmlj07k9h4z0h09rw74y8q2lf7u2aawzep5sh88q2yssdpqw35xjueqv4ehggryv4ekxunfwp6xjmmwcqzzsxqrrsssp5x2caq6vf5fep7yuwtunzddaln6fncnuvmpnmhezaxgxcy9gxh7qq9qxpqysgqn5vu6c0k2jhut8h6rwg5nryl9s4dsumvhf5jfa2793q966ygayx3qmh65cqun4anr945r9sc8fj6graqjm6tdgt49275h0fen64mj6cpw6erem",
        "lightning_address_id": null,
        "metadata": {
            "email": "[email protected]",
            "userID": "abc123"
        }
    }
}

Get Deposit​

GET

https://api.bitvora.com/v1/transactions/deposits/:depositID

const axios = require('axios');
let data = '';

let config = {
  method: 'get',
  maxBodyLength: Infinity,
  url: 'https://api.bitvora.com/v1/transactions/deposits/6d4a4129-f44f-4870-9f3f-dc5079715a21',
  headers: { },
  data : data
};

axios.request(config)
.then((response) => {
  console.log(JSON.stringify(response.data));
})
.catch((error) => {
  console.log(error);
});


{
    "status": 200,
    "message": "Bitcoin deposit fetched successfully",
    "data": {
        "id": "6d4a4129-f44f-4870-9f3f-dc5079715a21",
        "company_id": "6fc6625d-b913-41cb-9096-d442ba2e567b",
        "ledger_tx_id": "1cec1566-279b-4b49-85d9-1067d21da306",
        "recipient": "lntbs200u1pnfzmfzpp5lgjteza6k4rhk9g93r969meckxy23t9z33g6cmq3p384a5vu566qdqhw35xjueqd9ejqcfqw3jhxaqcqzzsxqzlgsp5r8x6xl32fx48rkr6uh22zc3wkap3ngejdtawt3ar80vcyv96pq8q9qxpqysgqtj3pc8eskeukw64st2td27rrwe56pu4pq48f89jyeatufpsjgscy0wl5lvrlcpjdndz4vkd497ct6e3qflm6gtvwhj6lrkjvecucrqspmxg5kt",
        "amount_sats": 20000,
        "network_type": "signet",
        "rail_type": "lightning",
        "status": "settled",
        "chain_tx_id": null,
        "lightning_invoice_id": "1c1a62be-e447-411d-895e-47ae5a15eab5",
        "created_at": "2024-07-12T17:52:27.62209Z",
        "updated_at": "2024-07-12T17:52:27.62209Z"
    }
}

Get Bitcoin Balance​

GET

https://api.bitvora.com/v1/transactions/balance

const axios = require('axios');
let data = '';

let config = {
  method: 'get',
  maxBodyLength: Infinity,
  url: 'https://api.bitvora.com/v1/transactions/balance',
  headers: { },
  data : data
};

axios.request(config)
.then((response) => {
  console.log(JSON.stringify(response.data));
})
.catch((error) => {
  console.log(error);
});


{
    "status": 200,
    "message": "Bitcoin balance fetched successfully",
    "data": {
        "balance": 74024
    }
}

Get Transactions​

GET

https://api.bitvora.com/v1/transactions

const axios = require('axios');
let data = '';

let config = {
  method: 'get',
  maxBodyLength: Infinity,
  url: 'https://api.bitvora.com/v1/transactions',
  headers: { },
  data : data
};

axios.request(config)
.then((response) => {
  console.log(JSON.stringify(response.data));
})
.catch((error) => {
  console.log(error);
});

{
    "status": 200,
    "message": "Bitcoin transactions fetched successfully",
    "data": [
        {
            "id": "bc533a7d-edfd-4f93-b1cf-76284ede242b",
            "company_id": "ccfe5fbe-47de-448d-9b99-fcfeb3254ee4",
            "amount_sats": 200,
            "recipient": "lntbs2u1pn0mtv9pp5rvytuyxhjty6ln73afj05zf349weyvfzystkfvt5pngxs7c960psdqqcqzzsxqyz5vqsp5v7yfqw90740dpcy20cqs45l0zqdx0usu2j62qtn3543cfvv274ts9qxpqysgqlkew4yxle9kgff3qysllusg9sfywzav2eq6luwxttkxkuc54leh9kccmrzr3wau4pwha0ddzhz4m3hywzl4pf0u8600xfafww5wjqsgpgkqcw8",
            "rail_type": "lightning",
            "type": "withdrawal",
            "fee_microsats": 600000,
            "status": "settled",
            "created_at": "2024-10-02T20:31:12.563814Z"
        },
        {
            "id": "1d5e516a-4bfd-4217-95b6-444e179c7df6",
            "company_id": "ccfe5fbe-47de-448d-9b99-fcfeb3254ee4",
            "amount_sats": 100000,
            "recipient": "lntbs1m1pn0mt2wpp5j2kj7wx5q3scs9mk0efldu7vdu9lrrnrl8h4c3pr4fa3lyc26a3qdqcgf5hgan0wfsjqjtwwehkjcm9cqzzsxqrrsssp5sh3ygdvvyjf8ptrrlxf8d62d27uepqy0tferfywwyy2nckq48qlq9qxpqysgqm42f8sl2gmg3nl6979esj3xu7q27uyvjmm6rkt353c7ur2gwtvf94j65xal4zdhrq9sp9ss0w882y88kxpz5ftqxreqnqqpemex250sqz7gshh",
            "rail_type": "lightning",
            "type": "deposit",
            "fee_microsats": 300000000,
            "status": "settled",
            "created_at": "2024-10-02T20:30:22.992607Z"
        }
    ]
}