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.It is possible to filter 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:24104621239246:rv8KtH5:1",
"amount": {
"value": 10,
"currencyCode": "EUR"
},
"runningBalance": {
"value": 100,
"currencyCode": "EUR"
},
"originator": {
"entity": {
"type": "COMPANY",
"name": "Some company"
},
"bankAccount": {
"accountNumberFormat": "IBAN",
"accountNumber": "GB15SYPE04082500002103",
"bankCode": "CLRBGB22"
}
},
"beneficiary": {
"entity": {
"type": "INDIVIDUAL",
"firstName": "Some",
"lastName": "Individual"
},
"bankAccount": {
"accountNumberFormat": "SCAN",
"accountNumber": "00002287",
"bankCode": "040825"
}
},
"details": {
"paymentMethod": "SEPA_INST"
},
"createdAt": "2025-02-27T00:00:00Z"
}
],
"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 |
payment.type | String | The type of transaction which is being listed. |
runningBalance | String | The real-time balance of the wallet from which the transaction relates to. |
transactionReference | String | Unique reference identifier for the transaction. |
paymentReference | String | Reference or description for the payment. |
amount | Object | Object containing the amount and currency of the transaction. |
walletId | String | Specific wallet ID. |
beneficiaryType | String | To specific if the beneficiary is a business or individual. |
currencyCode | String | Specify the currency. Possible values: - USD - EUR - GBP |
pageNumber | String | Starts from 0. |
pageSize | String | Limits the amount of returned customers in a response. |
paymentMethod | String | Explaining to which payment method the transaction belongs, for example: SEPA Credit, SEPA Instant, ACH, Fedwire, FPS, CHAPS, or SWIFT |
runningBalance | String | The real-time balance of the wallet from which the transaction relates to. |
Updated 1 day ago