Retrieve an account

Retrieve an account’s details using its AccountId, for example after finding it in a list or search result. Use the response to check its currency, balance, payment limit, type and status before a subsequent account or payment operation.

Endpoints

EnvironmentMethod and URL
StagingGET https://api.staging.vitesse.io/v1/payment-initiation/merchantAccounts/{id}
Production – UK HubGET https://api.vitesse.io/v1/payment-initiation/merchantAccounts/{id}
Production – US HubGET https://api.us.vitesse.io/v1/payment-initiation/merchantAccounts/{id}

Replace {id} with the account’s AccountId.

For help choosing an environment, see Environment.

Access requirements

Configure the following access:

OAuth scopeIdentity client role
payment-requestspayment-requests.manager

For more information about scopes, see Authentication. For information about the access granted by specific roles, see Identity client roles.

Send the request

GET https://api.staging.vitesse.io/v1/payment-initiation/merchantAccounts/4111

Example response

This example uses the Staging environment and retrieves account 4111:

{
  "MerchantId": "8e94f56b-6d5c-4fb7-b735-fef32ce8709e",
  "MerchantCode": "INS",
  "AccountId": 4111,
  "Name": "Claims GBP",
  "Code": "CLAIMS-GBP",
  "Alias": "UK claims",
  "Currency": "GBP",
  "AccountBalance": 248139.87,
  "UpperPaymentLimit": 50000.00,
  "UpperPaymentLimitCurrency": "GBP",
  "SubAccountType": "Standard",
  "Status": "Active",
  "SecurityGroupId": 142,
  "LinkedMerchantIds": [
    "6205ca5f-f0b3-44cd-b5ee-693babfc6c45"
  ],
  "AccessAllowedForUserIds": [],
  "UpdatedAt": "2026-09-14T14:11:58.268Z"
}

Troubleshoot the request

If the request fails, use the returned HTTP status code to identify the likely cause and corrective action.

For error response formats, additional HTTP status codes and error-handling guidance, see Error responses.

Next steps

Use the account ID to retrieve its current balance with Retrieve an account balance, or review its activity with List account entries. To view balance summaries, see List account balances.