List account entries
List the credits and debits recorded against an account to review its activity, investigate a balance change or support reconciliation.
Each entry shows the amount credited or debited and the resulting account balance. Use the entry amounts, balances and any payment or funding references to reconcile account activity with your records.
Endpoints
| Environment | Method and URL |
|---|---|
| Staging | GET https://staging-api.vitessepsp.com/api/account/{id} |
| Production – UK Hub | GET https://api.vitessepsp.com/api/account/{id} |
| Production – US Hub | GET https://api.us.vitesse.io/api/account/{id} |
Replace {id} with the account’s AccountId.
For help choosing an environment, see Environment.
Access requirements
Configure the following access:
| OAuth scope | Identity client role |
|---|---|
API | Accounts.Lookup |
For more information about scopes, see Authentication. For information about the access granted by specific roles, see Identity client roles.
Query parameters
Use only one of these filters per request: TransactionRequestId, MaxId, a date range, or an entry ID range. You can combine Count with any one of them.
Provide both bounds for a date or entry ID range.
| Parameter | Type | When to use it |
|---|---|---|
Count | Integer | Set the maximum number of entries to return. The default is 25; the accepted range is 1 to 100. |
TransactionRequestId | UUID | Return entries associated with a transaction request. |
MaxId | Integer | Set the maximum entry ID to include. |
StartDate | Date-time | Set the start of a date range. Also provide EndDate. Set StartDate earlier than EndDate. The API rejects equal dates. |
EndDate | Date-time | Set the end of a date range. Also provide StartDate |
StartEntryId | Integer | Set the first entry ID in a range. Also provide EndEntryId. |
EndEntryId | Integer | Set the last entry ID in a range. Also provide StartEntryId. |
Send the request
This example uses the Staging environment and requests account entries for account 4152:
curl --request GET \
--url 'https://staging-api.vitessepsp.com/api/account/4152' \
--header 'Authorization: Bearer <access-token>' \
--header 'Accept: application/json'Replace <access-token> with a valid access token that contains the required scope, and any example values with your own details.
You can narrow the results to investigate activity during a particular period or find entries associated with a payment:
| Query parameter | Use |
|---|---|
request.startDate | Include entries created on or after this date and time. |
request.endDate | Include entries created on or before this date and time. |
request.transactionRequestId | Find entries associated with a payment. |
The endpoint returns account entries in pages. Use the following query parameters to set the page size or retrieve entries with IDs less than a specified value:
| Query parameter | Use |
|---|---|
request.count | Return up to this many entries per page. Specify a value from 1 to 100. |
request.maxId | Return entries with an AccountEntryId lower than this value. |
If you omit
request.count, the API returns up to 25 entries per page.
This example requests up to 100 entries created between 7 September 2026 at 00:00 UTC and 14 September 2026 at 00:00 UTC:
curl --request GET \
--url 'https://staging-api.vitessepsp.com/api/account/4152?request.startDate=2026-09-07T00%3A00%3A00Z&request.endDate=2026-09-14T00%3A00%3A00Z&request.count=100' \
--header 'Authorization: Bearer <access-token>' \
--header 'Accept: application/json'Example response
A successful request returns 200 OK. The AccountEntrySummaries array contains the entries returned for the account.
This example shows a payment debit and a funding credit. The fields included in an entry depend on the activity it records.
{
"AccountEntrySummaries": [
{
"AccountCurrencyCode": "GBP",
"AccountEntryId": 902341,
"AccountEntryTypeName": "Payout",
"AccountId": 4152,
"Amount": 2942.87,
"Balance": 1095800.75,
"CreatedOn": "2026-09-13T10:15:00Z",
"DestinationCurrencyCode": "GBP",
"DestinationValue": 2942.87,
"EntryNumber": 128,
"ExchangeRate": 1.0,
"IsDebit": true,
"Narrative": "Claim payment",
"SourceCurrencyCode": "GBP",
"SourceValue": 2942.87,
"TransactionReference1": "5838386",
"TransactionReference2": "CLM38514",
"TransactionRequestId": "747101ce-2d0c-41bd-ae4a-ba5a0c267c70"
},
{
"AccountCurrencyCode": "GBP",
"AccountEntryId": 902340,
"AccountEntryTypeName": "Merchant Liquidity",
"AccountId": 4152,
"Amount": 98743.62,
"Balance": 1098743.62,
"CreatedOn": "2026-09-13T09:00:00Z",
"EntryNumber": 127,
"IsDebit": false,
"Narrative": "Funding received",
"TransactionReference1": "FND20260913",
"TransactionReference2": "Claims funding"
}
],
}The first entry in an account records its initial balance and has an EntryNumber of 0.
Use the following fields to interpret the activity:
AccountEntryTypeNamedescribes the activity, such asPayoutorMerchant Liquidity.CreatedOnshows when Vitesse created the entry.IsDebitdistinguishes money leaving the account (true) from money entering it (false).Amountshows the amount credited or debited.Balanceshows the account’s total balance after Vitesse applies the credit or debit.
Retrieve further pages
A single response might not contain every entry that matches your request.
If more results are available, the response includes a Links array containing a Next Page URL. Use this URL to retrieve the next page of results, including your access token in the Authorization header. Continue following the next-page links until the response no longer provides one.
Troubleshoot the request
If the request fails, use the returned HTTP status code to identify the likely cause and corrective action.
If Vitesse returns 200 OK with an empty AccountEntrySummaries array, no entries matched the request. Check the account ID and any filters you supplied.
If you specify a date or entry-ID range, check that its start does not exceed its end.
For error response formats, additional HTTP status codes and error-handling guidance, see Error responses.
Next steps
To retrieve the account’s current balance, see Retrieve an account balance. To view its balance summaries, see List account balances.
Updated 15 days ago