Retrieve Customer Wallets

The endpoint provides comprehensive information for each wallet, including status, balance, and other relevant details. This enables efficient monitoring and management of all payment channels linked to the customer, ensuring full operational visibility. You can list all wallets assigned to an Embedded Partner Customer and retrieve information for a specific wallet by providing its reference.

Retrieve all wallets

📘
Note
This endpoint includes pagination.

page: page number which starts from 0

size: page size which limits the number of returned customers in the response

To list all the wallets associated with a specific EPC, send the GET /ledger/v1/wallets request.

In the response, you receive the detailed information on each wallet:

{
            "id": "a:24022750724956:MPrtfLD:1",
            "accountReference": "ceb9400d-eee2-4cc0-89dc-1b3548f7291d",
            "customerReference": null,
            "name": "USD Wallet",
            "status": "ACTIVE",
            "balance": {
                "value": 21.62,
                "currencyCode": "USD"
            },
            "ledgers": []
        },
        {
            "id": "a:24092653283411:HZd7KrF:1",
            "accountReference": "ceb9400d-eee2-4cc0-89dc-1b3548f7291d",
            "customerReference": null,
            "name": "Tronix TRX",
            "status": "ACTIVE",
            "balance": {
                "value": 53.31,
                "currencyCode": "TRX"
            },
            "ledgers": []
        },
        {
            "id": "a:24073150033320:NOhqqbf:1",
            "accountReference": "ceb9400d-eee2-4cc0-89dc-1b3548f7291d",
            "customerReference": null,
            "name": "Bitcoin",
            "status": "ACTIVE",
            "balance": {
                "value": 0.00,
                "currencyCode": "BTC"
            },
            "ledgers": []
        },
        {
            "id": "a:24070454702353:HsMiNnh:1",
            "accountReference": "ceb9400d-eee2-4cc0-89dc-1b3548f7291d",
            "customerReference": null,
            "name": "FXBO Wallet",
            "status": "ACTIVE",
            "balance": {
                "value": 29.70,
                "currencyCode": "USDT"
            },
            "ledgers": []
        },
        {
            "id": "a:24050344483592:qc5L4gn:1",
            "accountReference": "ceb9400d-eee2-4cc0-89dc-1b3548f7291d",
            "customerReference": null,
            "name": "USDT Wallet for Razed Staging",
            "status": "ACTIVE",
            "balance": {
                "value": 7.99,
                "currencyCode": "USDT"
            },
            "ledgers": []
        },
        {
            "id": "a:24041555298083:pbldQsd:1",
            "accountReference": "ceb9400d-eee2-4cc0-89dc-1b3548f7291d",
            "customerReference": null,
            "name": "USDT Wallet",
            "status": "ACTIVE",
            "balance": {
                "value": 0.00,
                "currencyCode": "USDT"
            },
            "ledgers": []
        },
        {
            "id": "a:24022750724956:MPrtfLD:1",
            "accountReference": "ceb9400d-eee2-4cc0-89dc-1b3548f7291d",
            "customerReference": null,
            "name": "USD Wallet",
            "status": "ACTIVE",
            "balance": {
                "value": 21.62,
                "currencyCode": "USD"
            },
            "ledgers": []
        },
        {
            "id": "a:24022356065814:B9JE7bQ:1",
            "accountReference": "ceb9400d-eee2-4cc0-89dc-1b3548f7291d",
            "customerReference": null,
            "name": "EUR Wallet",
            "status": "ACTIVE",
            "balance": {
                "value": 370.14,
                "currencyCode": "EUR"
            },
            "ledgers": []
        },
        {
            "id": "a:24021450794096:mzUaZb5:1",
            "accountReference": "ceb9400d-eee2-4cc0-89dc-1b3548f7291d",
            "customerReference": null,
            "name": "USDT Wallet",
            "status": "ACTIVE",
            "balance": {
                "value": 567.60,
                "currencyCode": "USDT"
            },
            "ledgers": []
        },
        {
            "id": "a:24021442804147:PU2Fz2X:1",
            "accountReference": "ceb9400d-eee2-4cc0-89dc-1b3548f7291d",
            "customerReference": null,
            "name": "Daryl Casino",
            "status": "ACTIVE",
            "balance": {
                "value": -43.18,
                "currencyCode": "EUR"
            },
            "ledgers": []
        },
        {
            "id": "a:24011750230328:t3R1kK7:1",
            "accountReference": "ceb9400d-eee2-4cc0-89dc-1b3548f7291d",
            "customerReference": null,
            "name": "EUR Sweep",
            "status": "ACTIVE",
            "balance": {
                "value": 0.00,
                "currencyCode": "EUR"
            },
            "ledgers": []
        },
        {
            "id": "a:24011061973541:zMk2UD1:1",
            "accountReference": "ceb9400d-eee2-4cc0-89dc-1b3548f7291d",
            "customerReference": null,
            "name": "Ethereum",
            "status": "ACTIVE",
            "balance": {
                "value": 0.59,
                "currencyCode": "ETH"
            },
            "ledgers": []
        },
        {
            "id": "a:24011061897136:KbdefEQ:1",
            "accountReference": "ceb9400d-eee2-4cc0-89dc-1b3548f7291d",
            "customerReference": null,
            "name": "Euro",
            "status": "ACTIVE",
            "balance": {
                "value": 0.00,
                "currencyCode": "EUR"
            },
            "ledgers": []
        },
        {
            "id": "a:24011028265532:Sm9zOQf:1",
            "accountReference": "ceb9400d-eee2-4cc0-89dc-1b3548f7291d",
            "customerReference": null,
            "name": "Bitcoin",
            "status": "ACTIVE",
            "balance": {
                "value": 0.00,
                "currencyCode": "BTC"
            },
            "ledgers": []
        }
    ],
    "pageable": {
        "pageNumber": 0,
        "pageSize": 20,
        "sort": [],
        "offset": 0,
        "paged": true,
        "unpaged": false
    },
    "last": true,
    "totalElements": 15,
    "totalPages": 1,
    "first": true,
    "size": 20,
    "number": 0,
    "sort": [],
    "numberOfElements": 15,
    "empty": false
}

Parameter	Type	Description
id	String	The unique wallet ID
accountReference	String	The account reference for this wallet
customerReference	String	The customer reference for this wallet
name	String	The wallet name.
status	String	The status of the wallet. Possible values: `INACTIVE` `ACTIVE`
balance	Object	Information about the available balance within the wallet
balance. value	Number	The available amount
balance. currencyCode	String	The currency of the wallet
ledgers	Object	Contains information about the ledger
ledgers. type	String	The type of ledger. Possible values: `FIAT` `CRYPTO`
ledgers. accountNumber	String	The account number. Example: `GB25LHVB04030800071801` Will be provided only if `ledgers.type` = `FIAT`
ledgers. code	String	The account code. Example: `LHVBGB2L` Will be provided only if `ledgers.type` = `FIAT`
ledgers. accountNumberFormat	String	Speficies the account number format. Possible values: `IBAN` `SCAN` `SWIFT` `ABA` `BBAN` `CBIT`.Will be provided only if `ledgers.type` = `FIAT`
ledgers. address	String	The crypto wallet address. Will be provided only if `ledgers.type` = `CRYPTO`
ledgers. network	String	The crypto wallet network/protocol. Will be provided only if `ledgers.type` = `CRYPTO`
ledgers. tag	String	The crypto wallet tag (where applicable). Will be provided only if `ledgers.type` = `CRYPTO`

Retrieve wallet details by Customer reference

To retrieve wallet details by Customer reference, send the GET ledger/v1/wallets?customerReference={customerReference} request with the {customerReference} specified in the path.

curl --location 'https://api.sandbox.bvnk.com/ledger/v1/wallets?customerReference=a7e21c62-27b8-4b3b-b51e-eb10edeb1731' \
--header 'Authorization: Hawk id="vbfc61D890wg6LAAVbkR11qP9O6cXeMNmKWgcUNZaOHPiQeebp9cl6h02tWv84R8", ts="1728656563", nonce="voxeUs", mac="BO+hrUzE/tcWS89xTtvdfDacf+hQbtbHlAG9kwvyMuI="'

In the response, you receive the list with detailed information on each Customer wallet:

{
    "content": [
        {
            "id": "a:24101151618956:Xlfn0oR:1",
            "accountReference": "ceb9400d-eee2-4cc0-89dc-1b3548f7291d",
            "customerReference": "a7e21c62-27b8-4b3b-b51e-eb10edeb1731",
            "name": "My USD Wallet",
            "status": "INACTIVE",
            "balance": {
                "value": 0.00,
                "currencyCode": "USD"
            },
            "ledgers": []
        },
        {
            "id": "a:24101151422432:gCl7SeI:1",
            "accountReference": "ceb9400d-eee2-4cc0-89dc-1b3548f7291d",
            "customerReference": "a7e21c62-27b8-4b3b-b51e-eb10edeb1731",
            "name": "My USD Wallet 2",
            "status": "INACTIVE",
            "balance": {
                "value": 0.00,
                "currencyCode": "USD"
            },
            "ledgers": []
        }
    ],
    "pageable": {
        "pageNumber": 0,
        "pageSize": 20,
        "sort": [],
        "offset": 0,
        "paged": true,
        "unpaged": false
    },
    "last": true,
    "totalElements": 2,
    "totalPages": 1,
    "first": true,
    "size": 20,
    "number": 0,
    "sort": [],
    "numberOfElements": 2,
    "empty": false
}

Retrieve wallet details by Wallet ID

To retrieve wallet details by its unique identifier, send the GET ledger/v1/wallets/{id} request with the {id} specified in the path.

curl --location 'https://api.sandbox.bvnk.com/ledger/v1/wallets/a:24101151422432:gCl7SeI:1' \
--header 'Authorization: Hawk id="vbfc61D890wg6LAAVbkR11qP9O6cXeMNmKWgcUNZaOHPiQeebp9cl6h02tWv84R8", ts="1728656463", nonce="3eTREz", mac="Ba7hBB5IpsG2P0Y6/cYSijO5w992yS6wZiNvjmiRpuU="'

In the response, you receive the detailed information on the wallet:

{
    "id": "a:24101151422432:gCl7SeI:1",
    "accountReference": "ceb9400d-eee2-4cc0-89dc-1b3548f7291d",
    "customerReference": "a7e21c62-27b8-4b3b-b51e-eb10edeb1731",
    "name": "My USD Wallet 2",
    "status": "INACTIVE",
    "balance": {
        "value": 0.00,
        "currencyCode": "USD"
    },
    "ledgers": []
}

Retrieve all wallets

📘Note

Retrieve wallet details by Customer reference

Retrieve wallet details by Wallet ID

📘
Note