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.

Get Customer Accounts List

get

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

Authorizations
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
200
Successful retrieval of customer accounts.
application/json
get
GET /api/v1/customers/{customer_uuid}/accounts HTTP/1.1
Host: 
Authorization: Bearer JWT
Accept: */*
[
  {
    "uuid": "123e4567-e89b-12d3-a456-426614174000",
    "status": "created",
    "customer_uuid": "123e4567-e89b-12d3-a456-426614174000",
    "account_name": "My account",
    "account_number": "LT433400015000036002",
    "currency": "EUR",
    "opening_date": "2025-04-11",
    "opening_date_unix": 1744373843,
    "balance": 100.5,
    "balance_national": 100.5,
    "book_balance": 0,
    "book_balance_national": 0,
    "available_balance": 100.5,
    "available_balance_national": 100.5,
    "hold": 0,
    "cards_reserved_amount": 0,
    "cards_reserved_amount_national": 0,
    "created_at": 1744373843,
    "updated_at": 1744373843
  }
]

Get Specific Account Details

get

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

Authorizations
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
200
Successful retrieval of account details.
application/json
get
GET /api/v1/customers/{customer_uuid}/accounts/{account_uuid} HTTP/1.1
Host: 
Authorization: Bearer JWT
Accept: */*
{
  "uuid": "123e4567-e89b-12d3-a456-426614174000",
  "status": "created",
  "customer_uuid": "123e4567-e89b-12d3-a456-426614174000",
  "account_name": "My account",
  "account_number": "LT433400015000036002",
  "currency": "EUR",
  "opening_date": "2025-04-11",
  "opening_date_unix": 1744373843,
  "balance": 100.5,
  "balance_national": 100.5,
  "book_balance": 0,
  "book_balance_national": 0,
  "available_balance": 100.5,
  "available_balance_national": 100.5,
  "hold": 0,
  "cards_reserved_amount": 0,
  "cards_reserved_amount_national": 0,
  "created_at": 1744373843,
  "updated_at": 1744373843
}

Last updated

Was this helpful?