Accounts

Guru Pay allows you to fetch account information for customers via two endpoints:

  • One for listing all accounts tied to a specific customer.

  • One for retrieving detailed data about a single account.

circle-exclamation

Get Customer Accounts List

get
/api/v1/customers/{customer_uuid}/accounts

Retrieves a paginated list of accounts associated with the given customer UUID.

Authorizations
AuthorizationstringRequired

Authentication using a Bearer token.

Path parameters
customer_uuidstring · uuidRequired

Universally Unique Identifier (UUID) as defined by RFC 4122.

Example: e1f8a3b1-7d6c-4e9a-9b2e-3f8d1a9c5f2gPattern: ^[a-zA-Z0-9]{8}-[a-zA-Z0-9]{4}-[a-zA-Z0-9]{4}-[a-zA-Z0-9]{4}-[a-zA-Z0-9]{12}$
Query parameters
per_pageinteger · min: 1 · max: 100Optional

Number of items to return per page in a paginated response.

Default: 15Example: 15
pageinteger · min: 1Optional

The current page number for paginated results.

Default: 1Example: 1
Responses
chevron-right
200

Successful retrieval of customer accounts.

application/json
get
/api/v1/customers/{customer_uuid}/accounts

Get Specific Account Details

get
/api/v1/customers/{customer_uuid}/accounts/{account_uuid}

Retrieves the full details for a single account identified by its UUID, scoped to a specific customer.

Authorizations
AuthorizationstringRequired

Authentication using a Bearer token.

Path parameters
customer_uuidstring · uuidRequired

Universally Unique Identifier (UUID) as defined by RFC 4122.

Example: e1f8a3b1-7d6c-4e9a-9b2e-3f8d1a9c5f2gPattern: ^[a-zA-Z0-9]{8}-[a-zA-Z0-9]{4}-[a-zA-Z0-9]{4}-[a-zA-Z0-9]{4}-[a-zA-Z0-9]{12}$
account_uuidstring · uuidRequired

Universally Unique Identifier (UUID) as defined by RFC 4122.

Example: e1f8a3b1-7d6c-4e9a-9b2e-3f8d1a9c5f2gPattern: ^[a-zA-Z0-9]{8}-[a-zA-Z0-9]{4}-[a-zA-Z0-9]{4}-[a-zA-Z0-9]{4}-[a-zA-Z0-9]{12}$
Responses
chevron-right
200

Successful retrieval of account details.

application/json
uuidstring · uuidOptional

The unique identifier (UUID) of the account.

statusstring · enumOptional

The current status of the account.

Possible values:
customer_uuidstring · uuidOptional

The unique identifier (UUID) of the customer who owns this account.

account_namestring · nullableOptional

The name associated with the account.

Example: My account
account_numberstringOptional

The unique account number.

Example: LT433400015000036002
currencystring · enumOptional

The currency code of the account

Possible values:
opening_datestring · dateOptional

The date when the account was opened (ISO 8601 format).

Example: 2025-04-11
opening_date_unixinteger · int64Optional

A Unix timestamp in seconds.

Example: 1744373843
balancenumber · floatOptional

The current ledger balance of the account.

Example: 100.5
balance_nationalnumber · floatOptional

The current ledger balance of the account in the national currency.

Example: 100.5
book_balancenumber · floatOptional

The available book balance of the account. Not used

Example: 0
book_balance_nationalnumber · floatOptional

The available book balance of the account in the national currency. Not used

Example: 0
available_balancenumber · floatOptional

The current available balance of the account.

Example: 100.5
available_balance_nationalnumber · floatOptional

The current available balance of the account in the national currency.

Example: 100.5
holdnumber · floatOptional

The total amount of funds currently on hold in the account's currency. Not used

Example: 0
cards_reserved_amountnumber · floatOptional

The total amount reserved for card transactions in the account's currency. Not used

Example: 0
cards_reserved_amount_nationalnumber · floatOptional

The total amount reserved for card transactions in the national currency. Not used

Example: 0
created_atinteger · int64Optional

A Unix timestamp in seconds.

Example: 1744373843
updated_atinteger · int64Optional

A Unix timestamp in seconds.

Example: 1744373843
account_typestring · enumOptional

The type of the account.

Possible values:
get
/api/v1/customers/{customer_uuid}/accounts/{account_uuid}

Last updated

Was this helpful?