Listing Transactions
This endpoint allows you to list all the specific transactions for a given customer, providing a comprehensive overview of their account. By accessing this Endpoint, you can retrieve detailed information about all of the transactions for a given customer, 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.
It is possible to request the list of transactions within a given time frame, where the start and end date can be specified.
Early Access
Please note that this endpoint is currently in early access, and it may undergo changes as we continue to improve and refine the functionality.
Note
This endpoint includes pagination.
page:page number which starts from 0.size:page size which limits the number of returned transactions in the response.The returned transactions have extra search filters which are not set to be shown in the response but shown on each of the transactions.
start:The start date-time filter for transactions. Transactions on or after this date will be included. Format: ISO8601.end:The end date-time filter for transactions. Transactions on or before this date will be included. Format: ISO8601.This endpoint requires filtering by walletID:
walletId:The ability to filter specific transactions by walletId.
Request
| Environment | Endpoint |
|---|---|
| Production | GET https://api.bvnk.com/ledger/v1/transactions |
| Sandbox | GET https://api.sandbox.bvnk.com/ledger/v1/transactions |
curl --location https:'//api.bvnk.com/ledger/v1/transactions?walletId=a:24104621239246:rv8KtH5:1&page=0&size=10&start=2025-01-01T00:00:00Z&end=2025-03-03T00:00:00Z' \
--header 'X-Idempotency-Key: cbb1007a-6cf6-409e-94ed-7bc08ed7f6e0' \
--header 'Content-Type: application/json' \
--header 'Authorization: Hawk
}'{
"content": [
{
"transactionId": "9478b050-4a14-44e3-a287-bede56dcd567",
"paymentId": "7044d2bc-cc5b-40dc-bab1-12b5f9c127c1",
"paymentReference": "REF12345",
"type": "PAYOUT",
"status": "COMPLETED",
"walletId": "a:24103136208222:wSFXcWf:1",
"amount": {
"value": 10.00,
"currencyCode": "EUR"
},
"runningBalance": {
"value": 100.00,
"currencyCode": "EUR"
},
"originator": {
"entity": {
"type": "COMPANY",
"name": "Some company"
},
"bankAccount": {
"accountNumberFormat": "IBAN",
"accountNumber": "EE667777000028343400",
"bankCode": "LHVBEE20"
}
},
"beneficiary": {
"entity": {
"type": "INDIVIDUAL",
"firstName": "Some",
"lastName": "Individual"
},
"bankAccount": {
"accountNumberFormat": "IBAN",
"accountNumber": "NL23INGB8229094322",
"bankCode": "INGBNL2A"
}
},
"details": {
"paymentMethod": "SEPA_INST"
},
"createdAt": "2025-02-27T00:00:00Z"
},
{
"transactionId": "b405e8f2-19fe-11f0-a695-db405dbaeb5e",
"paymentId": "019639aa-a8fe-7470-9992-2296c4c3deef",
"paymentReference": "REF45291",
"type": "PAYIN",
"status": "COMPLETED",
"walletId": "a:24103136208222:wSFXcWf:1",
"amount": {
"value": 1000.00,
"currencyCode": "EUR"
},
"runningBalance": {
"value": 1177.56,
"currencyCode": "EUR"
},
"originator": {
"entity": {
"type": "INDIVIDUAL",
"firstName": "Some",
"lastName": "Individual"
},
"bankAccount": {
"accountNumberFormat": "IBAN",
"accountNumber": "NL23INGB8229094322",
"bankCode": "INGBNL2A"
}
},
"beneficiary": {
"entity": {
"type": "COMPANY",
"name": "Some company"
},
"bankAccount": {
"accountNumberFormat": "IBAN",
"accountNumber": "EE667777000028343400",
"bankCode": "LHVBEE20"
}
},
"details": {
"paymentMethod": "SEPA_INST"
},
"createdAt": "2025-04-15T13:36:58.598270Z"
},
{
"transactionId": "b405e8f2-19fe-11f0-a695-db405dbaeb5e",
"paymentId": "019639aa-a8fe-7470-9992-2296c4c3deef",
"paymentReference": "REF45291",
"type": "FEE",
"status": "COMPLETED",
"walletId": "a:24103136208222:wSFXcWf:1",
"amount": {
"value": 1000.00,
"currencyCode": "EUR"
},
"runningBalance": {
"value": 1177.56,
"currencyCode": "EUR"
},
"originator": {
"entity": {
"type": "INDIVIDUAL",
"firstName": "Some",
"lastName": "Individual"
},
"bankAccount": {
"accountNumberFormat": "IBAN",
"accountNumber": "NL23INGB8229094322",
"bankCode": "INGBNL2A"
}
},
"beneficiary": {
"entity": {
"type": "COMPANY",
"name": "Some company"
},
"bankAccount": {
"accountNumberFormat": "IBAN",
"accountNumber": "EE667777000028343400",
"bankCode": "LHVBEE20"
}
},
"details": {
"paymentMethod": "SEPA_INST"
},
"createdAt": "2025-04-15T13:36:58.598270Z"
},
],
"pageable": {
"pageNumber": 0,
"pageSize": 20,
"sort": [],
"offset": 0,
"paged": true,
"unpaged": false
},
"last": true,
"totalElements": 1,
"totalPages": 1,
"first": true,
"size": 20,
"number": 0,
"sort": [],
"numberOfElements": 1,
"empty": false
}Attribute | Type | Description |
|---|---|---|
transactionId | String | The unique reference for the transaction. |
paymentId | String | The unique reference for the payment. |
paymentReference | String | Reference or description for the payment. |
type | String | The type of transaction which is being listed.
|
status | String | The status of transaction.
|
walletId | String | Specific wallet ID. |
amount | Object | Object containing the amount and currency code of the transaction. |
amount.value | Number | Value of the specific transaction. |
amount.currencyCode | String | Currency code of the amount.
|
runningBalance | Object | The real-time balance of the wallet from which the transaction relates to. |
runningBalance.value | Number | Value of the real-time wallet balance. |
amount.currencyCode | String | Currency code of the wallet transaction relates to.
|
originator | Object | Entity that initiated the transaction. |
originator.entity | Object | Entity information about originator. |
originator.entity.type | String | The type of originator entity.
|
originator.entity.name | String | The name of the originator (for companies). |
originator.entity.firstName | String | The first name of the originator (for individuals). |
originator.entity.lastName | String | The last name of the originator (for individuals). |
originator.bankAccount | Object | Bank account payment was initiated from. |
originator.bankAccount.bankCode | String | The bank code of the originator. |
originator.bankAccount.accountNumber | String | The account number of the originator. |
originator.bankAccount.accountNumberFormat | String | The format of the account number of the originator.
|
beneficiary | Object | End recipient of the payment. |
beneficiary.entity | Object | Entity information about beneficiary. |
beneficiary.entity.type | String | The type of beneficiary entity.
|
beneficiary.entity.name | String | The name of the beneficiary (for companies). |
beneficiary.entity.firstName | String | The first name of the beneficiary (for individuals). |
beneficiary.entity.lastName | String | The last name of the beneficiary (for individuals). |
beneficiary.bankAccount | Object | Bank account receiving the payment. |
beneficiary.bankAccount.bankCode | String | The bank code of the beneficiary. |
beneficiary.bankAccount.accountNumber | String | The account number of the beneficiary. |
beneficiary.bankAccount.accountNumberFormat | String | The format of the account number of the beneficiary.
|
details | Object | Additional transaction information. |
details.paymentMethod | String | Identifying the payment method used for the transaction.
|
Updated 11 days ago