Ctrlk
DashboardSandbox Dashboard
For the complete documentation index, see llms.txt. This page is also available as Markdown.

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.

You must include your Bearer token in the request header.

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
200

Successful retrieval of customer accounts.

application/json
get/api/v1/customers/{customer_uuid}/accounts
GET /api/v1/customers/{customer_uuid}/accounts HTTP/1.1
Host: public-api.gurupay.eu
Authorization: Bearer YOUR_SECRET_TOKEN
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,
    "available_balance": 100.5,
    "created_at": 1744373843,
    "updated_at": 1744373843,
    "account_type": "current",
    "virtual_account_holder": {
      "person_type": "natural",
      "address": {
        "street_name": "Financial Square",
        "building_number": "1",
        "building_name": "Tower A",
        "post_code": "EC2A 1AA",
        "town_name": "London",
        "country_sub_division": "Greater London",
        "country_code": "GB"
      },
      "person_data": {
        "first_name": "John",
        "last_name": "Doe",
        "citizenship": "US",
        "address": {
          "street_name": "Financial Square",
          "building_number": "1",
          "building_name": "Tower A",
          "post_code": "EC2A 1AA",
          "town_name": "London",
          "country_sub_division": "Greater London",
          "country_code": "GB"
        }
      },
      "company_data": {
        "company_name": "Acme Ltd",
        "industry_type": "retail",
        "address": {
          "street_name": "Financial Square",
          "building_number": "1",
          "building_name": "Tower A",
          "post_code": "EC2A 1AA",
          "town_name": "London",
          "country_sub_division": "Greater London",
          "country_code": "GB"
        }
      },
      "parent_uuid": "374d7a86-a126-41ae-a6e1-f0d4ce78f333",
      "parent_iban": "LT433400015000016020",
      "external_id": "3a13204d-6d69-431f-89d5-da11b1c99686"
    }
  }
]

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
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 · floatOptionalDeprecated

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

Example: 100.5
book_balancenumber · floatOptionalDeprecated

The available book balance of the account. Not used

Example: 0
book_balance_nationalnumber · floatOptionalDeprecated

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 · floatOptionalDeprecated

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

Example: 100.5
holdnumber · floatOptionalDeprecated

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

Example: 0
cards_reserved_amountnumber · floatOptionalDeprecated

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

Example: 0
cards_reserved_amount_nationalnumber · floatOptionalDeprecated

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}
GET /api/v1/customers/{customer_uuid}/accounts/{account_uuid} HTTP/1.1
Host: public-api.gurupay.eu
Authorization: Bearer YOUR_SECRET_TOKEN
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,
  "available_balance": 100.5,
  "created_at": 1744373843,
  "updated_at": 1744373843,
  "account_type": "current",
  "virtual_account_holder": {
    "person_type": "natural",
    "address": {
      "street_name": "Financial Square",
      "building_number": "1",
      "building_name": "Tower A",
      "post_code": "EC2A 1AA",
      "town_name": "London",
      "country_sub_division": "Greater London",
      "country_code": "GB"
    },
    "person_data": {
      "first_name": "John",
      "last_name": "Doe",
      "citizenship": "US",
      "address": {
        "street_name": "Financial Square",
        "building_number": "1",
        "building_name": "Tower A",
        "post_code": "EC2A 1AA",
        "town_name": "London",
        "country_sub_division": "Greater London",
        "country_code": "GB"
      }
    },
    "company_data": {
      "company_name": "Acme Ltd",
      "industry_type": "retail",
      "address": {
        "street_name": "Financial Square",
        "building_number": "1",
        "building_name": "Tower A",
        "post_code": "EC2A 1AA",
        "town_name": "London",
        "country_sub_division": "Greater London",
        "country_code": "GB"
      }
    },
    "parent_uuid": "374d7a86-a126-41ae-a6e1-f0d4ce78f333",
    "parent_iban": "LT433400015000016020",
    "external_id": "3a13204d-6d69-431f-89d5-da11b1c99686"
  }
}
PreviousAuthentication
NextStatements

Last updated

Was this helpful?