Retrieve Wallet Details
This endpoint allows you to list all the wallets associated with a specific customer, providing a comprehensive overview of their account. By accessing this endpoint, you can retrieve detailed information about each wallet, including its status, balance, and any other relevant data. This functionality enables efficient management and monitoring of all payment channels linked to that customer, ensuring that you have full visibility. You could either list all wallets assigned to a customer or you could retrieve information directly by specifying the wallet reference. Examples below:
BETA Endpoints
Please note that these endpoints are currently in beta, and they may undergo changes as we continue to improve and refine the functionality.
Retrieve wallet details by Customer Reference
Note
This endpoint includes pagination.
page
: page number which starts from 0size
: page size which limits the number of returned customers in the response
Environment | Endpoint |
---|---|
Production | GET https://api.bvnk.com/ledger/v1/wallets?customerReference={customerReference} |
Sandbox | GET https://api.sandbox.bvnk.com/ledger/v1/wallets?customerReference={customerReference} |
curl --location 'https://api.sandbox.bvnk.com/ledger/v1/wallets?customerReference={customerReference}' \
--header 'Authorization: Hawk id="vOjKT0txxpp6TMQP6QTQziyBjAiVnMGNH3dbFa0SGhK7OFsMD6lWFPaN8TXCqkXk", ts="1724772959", nonce="BP1z-t", mac="hE8lI09+RMuhyH834VJnP6RNuQA+Cb97mWVWt1SGj9M="'
200 OK
{
"content": [
{
"id": "{id}",
"accountReference": "3399c975-e1c1-4acf-9a90-6cfbdcdeaaea",
"customerReference": "{customer reference}",
"name": "some Name",
"status": "ACTIVE",
"balance": {
"value": 100.00,
"currency": "EUR"
},
"ledgers": [
{
"status": "ACTIVE",
"accountNumberFormat": "IBAN",
"accountNumber": "someIban",
"code": "someBic",
"type": "FIAT"
},
{
"address": "some address",
"network": "some network",
"tag": "some tag",
"type": "CRYPTO"
}
]
},
{
"id": "{id}",
"accountReference": "3399c975-e1c1-4acf-9a90-6cfbdcdeaaea",
"customerReference": "{customer reference}",
"name": "some other name",
"status": "ACTIVE",
"balance": {
"value": 200.00,
"currency": "EUR"
},
"ledgers": [
{
"status": "ACTIVE",
"accountNumberFormat": "IBAN",
"accountNumber": "someIban",
"code": "someBic",
"type": "FIAT"
},
{
"address": "some address",
"network": "some network",
"tag": "some tag",
"type": "CRYPTO"
}
]
}
],
"pageable": {
"sort": {
"sorted": true,
"unsorted": false,
"empty": false
},
"pageNumber": 0,
"pageSize": 20,
"offset": 0,
"paged": true,
"unpaged": false
},
"totalPages": 5,
"totalElements": 100,
"last": false,
"first": true,
"sort": {
"sorted": true,
"unsorted": false,
"empty": false
},
"numberOfElements": 20,
"size": 20,
"number": 0,
"empty": false
}
Expected response details
Parameter | Type | Description |
---|---|---|
id | String | This is a unique identifier for a wallet to be used in future API calls. |
customerReference | String | Unique reference for a specific customer. |
accountReference | String | Unique reference for a specific account. |
name | String | The name of the wallet must be unique meaning that no other customer can have the same identical wallet name. |
status | String | This shows the status of the wallet. |
balance | Object | The available balance on the wallet. |
balance.value | Numerical | Value specifying the amount. |
balance.currency | Numerical | Currency of the wallet. |
ledgers | Object | |
ledgers.status | String | |
ledgers.accountNumberFormat | String | This refers to the type of Virtual Account, with the possible values being IBAN or SCAN . |
ledgers.accountNumber | String | This shows the Account Number of the customer’s Virtual Account. If type IBAN then the Account Number is an IBAN, if the type is SCAN then the Account Number will be a UK Account Number. |
ledgers.code | String | This shows the Account Code of the customer’s Virtual Account. If type IBAN then the Account Code is a BIC (Bank Identifier Code), if the type is SCAN then the Account Code will be a UK Sort Code. |
ledgers.type | String | This refers to the type of Virtual Account, with the possible values being FIAT or CRYPTO . |
ledgers.address | String | This shows the wallet address when crypto is used. |
ledgers.network | String | This shows the protocol when crypto is used. |
ledgers.tag | String | This shows the tag when crypto is used. |
Retrieve wallet details by Wallet ID
Environment | Endpoint |
---|---|
Production | GET https://api.bvnk.com/ledger/v1/wallets/{id} |
Sandbox | GET https://api.sandbox.bvnk.com/ledger/v1/wallets/{id} |
curl --location 'https://api.sandbox.bvnk.com/ledger/v1/wallets/{id}' \
--header 'Authorization: Hawk id="vOjKT0txxpp6TMQP6QTQziyBjAiVnMGNH3dbFa0SGhK7OFsMD6lWFPaN8TXCqkXk", ts="1724772959", nonce="BP1z-t", mac="hE8lI09+RMuhyH834VJnP6RNuQA+Cb97mWVWt1SGj9M="'
{
"accountReference": "3399c975-e1c1-4acf-9a90-6cfbdcdeaaea",
"balance": {
"currency": "EUR",
"value": 100.00
},
"customerReference": "b94dcf2a-d377-469e-8846-e21f65b18a77",
"id": "{id}",
"ledgers": [
{
"accountNumber": "someIban",
"accountNumberFormat": "IBAN",
"code": "someBic",
"status": "ACTIVE",
"type": "FIAT"
},
{
"address": "some address",
"network": "some network",
"tag": "some tag",
"type": "CRYPTO"
}
],
"name": "some other name",
"status": "ACTIVE"
}
Updated 8 days ago