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


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
}

AttributeTypeDescription
transactionIdStringThe unique reference for the transaction.
paymentIdStringThe unique reference for the payment.
paymentReferenceStringReference or description for the payment.
typeStringThe type of transaction which is being listed.
Possible values:

- PAYOUT
- PAYIN
- FEE
statusStringThe status of transaction.
Possible values:

- CREATED
- PROCESSING
- PENDING_APPROVAL
- ON_HOLD
- RETURNED
- EXPIRED
- CANCELLED
- FAILED
walletIdStringSpecific wallet ID.
amountObjectObject containing the amount and currency code of the transaction.
amount.valueNumberValue of the specific transaction.
amount.currencyCodeStringCurrency code of the amount.
Possible values:

- USD
- EUR
- GBP
runningBalanceObjectThe real-time balance of the wallet from which the transaction relates to.
runningBalance.valueNumberValue of the real-time wallet balance.
amount.currencyCodeStringCurrency code of the wallet transaction relates to.
Possible values:

- USD
- EUR
- GBP
originatorObjectEntity that initiated the transaction.
originator.entityObjectEntity information about originator.
originator.entity.typeStringThe type of originator entity.
Possible values:

- COMPANY
- INDIVIDUAL
originator.entity.nameStringThe name of the originator (for companies).
originator.entity.firstNameStringThe first name of the originator (for individuals).
originator.entity.lastNameStringThe last name of the originator (for individuals).
originator.bankAccountObjectBank account payment was initiated from.
originator.bankAccount.bankCodeStringThe bank code of the originator.
originator.bankAccount.accountNumberStringThe account number of the originator.
originator.bankAccount.accountNumberFormatStringThe format of the account number of the originator.
Possible values:

- SCAN
- IBAN
- SWIFT
- ABA
- BBAN
- UNKNOWN
beneficiaryObjectEnd recipient of the payment.
beneficiary.entityObjectEntity information about beneficiary.
beneficiary.entity.typeStringThe type of beneficiary entity.
Possible values:

- COMPANY
- INDIVIDUAL
beneficiary.entity.nameStringThe name of the beneficiary (for companies).
beneficiary.entity.firstNameStringThe first name of the beneficiary (for individuals).
beneficiary.entity.lastNameStringThe last name of the beneficiary (for individuals).
beneficiary.bankAccountObjectBank account receiving the payment.
beneficiary.bankAccount.bankCodeStringThe bank code of the beneficiary.
beneficiary.bankAccount.accountNumberStringThe account number of the beneficiary.
beneficiary.bankAccount.accountNumberFormatStringThe format of the account number of the beneficiary.
Possible values:

- SCAN
- IBAN
- SWIFT
- ABA
- BBAN
- UNKNOWN
detailsObjectAdditional transaction information.
details.paymentMethodStringIdentifying the payment method used for the transaction.
Possible values:

- SEPA_CT
- SEPA_INST
- FASTER_PAYMENT
- CHAPS
- ACH
- FEDWIRE
- BOOK
- SWIFT
- UNKNOWN