Get customer account

This API endpoint is used to retrieve details of a specific customer account using the unique customer and account identifiers. Optionally, you can include the current account balance in the response by passing includeAccountBalance=true as a query parameter.

SecurityoAuth2
Request
path Parameters
customerUID
required
string

Unique identifier of the customer. This is a mandatory path parameter used to identify the customer whose account information is being retrieved.

accountUID
required
string

Unique identifier of the account associated with the specified customer. This is a mandatory path parameter and should correspond to the correct account under the provided customer UID.

Example: 101
query Parameters
includeAccountBalance
boolean

Pass this as true if to pull in account balance as well, false otherwise

Responses
200

OK

400

Bad request

401

You are not authorized to access the resource

403

Accessing the resource you were trying to reach is forbidden

404

The resource you were trying to reach is not found

500

Internal server error

get/v3/customers/{customerUID}/accounts/{accountUID}
Request samples
Response samples
application/json
{
  • "data": {
    }
}