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

Statements

Manages generation and retrieval of account statement resources for a given customer. Use the Generate endpoint to create a statement asynchronously and receive its UUID. Once processing is complete, the Get endpoint can be used to fetch full details including a file_url for downloading the report. The List endpoint returns a paginated collection of statements for the specified customer and account.

Get Account Statement Details

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

Retrieves the full details for a single account statement 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 single customer account statement.

application/json
idintegerOptionalExample: 1
statusstringOptionalExample: active
typestringOptionalExample: statement
balance_typestringOptionalExample: credit
date_fromstring · dateOptionalExample: 2025-01-01
date_tostring · dateOptionalExample: 2025-01-31
account_idintegerOptionalExample: 1234
account_ibanstringOptionalExample: PL61109010140000071219812874
account_namestringOptionalExample: Main Company Account
created_atstring · date-timeOptionalExample: 2025-01-02T12:00:00Z
updated_atstring · date-timeOptionalExample: 2025-02-01T12:00:00Z
original_namestringOptionalExample: statement_january.pdf
mime_typestringOptionalExample: application/pdf
file_urlstring · uriOptionalExample: https://example.com/files/statement_january.pdf
get/api/v1/customers/{customer_uuid}/accounts/{account_uuid}/statements/{account_statement_uuid}
GET /api/v1/customers/{customer_uuid}/accounts/{account_uuid}/statements/{account_statement_uuid} HTTP/1.1
Host: public-api.gurupay.eu
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

[
  {
    "id": 1,
    "status": "active",
    "type": "statement",
    "balance_type": "credit",
    "date_from": "2025-01-01",
    "date_to": "2025-01-31",
    "account_id": 1234,
    "account_iban": "PL61109010140000071219812874",
    "account_name": "Main Company Account",
    "created_at": "2025-01-02T12:00:00Z",
    "updated_at": "2025-02-01T12:00:00Z",
    "original_name": "statement_january.pdf",
    "mime_type": "application/pdf",
    "file_url": "https://example.com/files/statement_january.pdf"
  }
]

List Account Statements

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

Retrieves a paginated list of accounts statements with the given customer UUID and account ID.

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 customer account statements.

application/json
get/api/v1/customers/{customer_uuid}/statements
GET /api/v1/customers/{customer_uuid}/statements HTTP/1.1
Host: public-api.gurupay.eu
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

[
  {
    "id": 1,
    "status": "active",
    "type": "statement",
    "balance_type": "credit",
    "date_from": "2025-01-01",
    "date_to": "2025-01-31",
    "account_id": 1234,
    "account_iban": "PL61109010140000071219812874",
    "account_name": "Main Company Account",
    "created_at": "2025-01-02T12:00:00Z",
    "updated_at": "2025-02-01T12:00:00Z"
  }
]

Generate Account Statement

post
/api/v1/customers/{customer_uuid}/accounts/{account_uuid}/generate-statement

Generate account statement in async way

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}$
Body

Data required to generate an account statement.

typestring · enumRequired

Type of report

Example: statementPossible values:
balance_typestring · enumRequired

Indicates whether we use available balance or balance (legacy) way to calculate the balance

Example: balancePossible values:
fromstring · dateRequired

Start date of the reporting period (YYYY-MM-DD)

Example: 2025-01-01
tostring · dateRequired

End date of the reporting period (YYYY-MM-DD)

Example: 2025-01-31
Responses
201

Generating account statement has been initiated.

application/json

ID from newly created resource

idstring · uuidOptional

The ID resource which has been created.

Example: e1f8a3b1-7d6c-4e9a-9b2e-3f8d1a9c5f2g
post/api/v1/customers/{customer_uuid}/accounts/{account_uuid}/generate-statement
POST /api/v1/customers/{customer_uuid}/accounts/{account_uuid}/generate-statement HTTP/1.1
Host: public-api.gurupay.eu
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 83

{
  "type": "statement",
  "balance_type": "balance",
  "from": "2025-01-01",
  "to": "2025-01-31"
}
{
  "id": "e1f8a3b1-7d6c-4e9a-9b2e-3f8d1a9c5f2g"
}

PreviousAccountsNextVirtual IBANs

Last updated

Was this helpful?