Ctrl+K

Account Information#

These endpoints allow you as a TPP to get information from the account of a Holvi customer.

Note

All these endpoints require authentication, see the authentication documentation for the full list of headers required for these endpoints.

Payment accounts#

A Holvi customer can have multiple payment accounts. Each payment account can hold only one type of currency and the user is able to give a name to it. The customer can have both regular (psd) and Holvi Credit (credit) accounts, see payment account types.

List#

GET /api/v2/payment-accounts/#

Returns a list of payment accounts for the given JWT token issued for a PSU (payment service user).

Note

Only payments from the last 365 days are returned.

Example response:

HTTP/1.1 200 OK
Vary: Accept
Content-Type: application/json

[
    {
        "uuid": "b06d5478-0954-451a-a1e0-f1eeb25336be",
        "currency": "EUR",
        "type": "psd",
        "name": "Main",
        "default": false,
        "iban": "FI7979977991294922",
        "bic": "HOLVFIHH",
        "balance": "11050.00",
        "available_balance": "10000.00",
        "state": "active"
    },
    {
        "uuid": "e1c0a9e6-5a1e-4a54-9a2c-2f9f1d3b7c48",
        "currency": "EUR",
        "type": "credit",
        "name": "Credit account",
        "default": false,
        "iban": "FI2179977991294930",
        "bic": "HOLVFIHH",
        "balance": "-250.00",
        "available_balance": "4750.00",
        "state": "active"
    }
]

Request Headers:

  • Host: Must be api.psd2.holvi.com

  • Date: Must follow the format described in section 7.1.1.1 of RFC 7231

  • Signature: See authentication documentation for more details

  • X-Holvi-Client-Id: Client ID provided by Holvi

  • X-Holvi-Client-Secret: Client secret provided by Holvi

  • Authorization: JWT token to authenticate

Status Codes:

  • 200: No error

  • 401: Unsuccessful authentication

Response body:

  • currency: Currency of the payment account

  • type: Type of the payment account, either psd (regular payment account) or credit (Holvi Credit account), see payment account types

  • name: Designated name of the payment account provided by the user

  • default: Indicates whether the payment account is the default one

  • balance: Balance of the account without account reservations. On a credit account this is the credit currently drawn and is normally zero or negative.

  • available_balance: Balance of the account including account reservations. On a credit account this also includes the remaining credit line.

Detail#

GET /api/v2/payment-accounts/(string:uuid)/#

Returns a payment account from uuid.

Example response:

HTTP/1.1 200 OK
Vary: Accept
Content-Type: application/json

{
    "uuid": "b06d5478-0954-451a-a1e0-f1eeb25336be",
    "currency": "EUR",
    "type": "psd",
    "name": "Main",
    "default": false,
    "iban": "FI7979977991294922",
    "bic": "HOLVFIHH",
    "balance": "11050.00",
    "available_balance": "10000.00",
    "state": "active"
}

Parameters:

Request Headers:

  • Host: Must be api.psd2.holvi.com

  • Date: Must follow the format described in section 7.1.1.1 of RFC 7231

  • Signature: See authentication documentation for more details

  • X-Holvi-Client-Id: Client ID provided by Holvi

  • X-Holvi-Client-Secret: Client secret provided by Holvi

  • Authorization: JWT token to authenticate

Status Codes:

  • 200: No error

  • 401: Unsuccessful authentication

Response body:

  • currency: Currency of the payment account

  • type: Type of the payment account, either psd (regular payment account) or credit (Holvi Credit account), see payment account types

  • name: Designated name of the payment account provided by the user

  • default: Indicates whether the payment account is the default one

  • balance: Balance of the account without account reservations. On a credit account this is the credit currently drawn and is normally zero or negative.

  • available_balance: Balance of the account including account reservations. On a credit account this also includes the remaining credit line.

Payments#

In payment responses, is_credit indicates whether the payment was booked on a Holvi Credit account (type: credit) instead of a regular one, see payment account types. It may be null for payments that have not been booked yet.

List#

GET /api/v2/payment-accounts/(string:uuid)/payments/#

Returns a list of payments for payment account uuid.

Example response:

Note

This response is shortened for brevity.

HTTP/1.1 200 OK
Vary: Accept
Content-Type: application/json

{
    "count": 10,
    "next": "https://api.psd2.holvi.com/api/v2/payment-accounts/b06d5478-0954-451a-a1e0-f1eeb25336b/payments/?page=2",
    "previous": null,
    "results": [
        {
            "uuid": "c437243b-c5a8-4629-b00c-773505868f0f",
            "counterparty": {
                "name": "Holvi",
                "bic": "",
                "account_identifier": "",
                "account_identifier_type": "iban"
            },
            "amount": "10.00",
            "currency": "EUR",
            "method": "sepa",
            "booking_date": null,
            "due_date": "2024-06-26",
            "execution_at": "2024-06-26T09:40:15.994768Z",
            "state": "scheduled",
            "direction": "out",
            "is_credit": null,
            "structured_reference": "",
            "unstructured_reference": "",
            "end_to_end_id": ""
        }
    ]
}

Parameters:

  • uuid: UUID of the payment account that can be fetched from GET /api/v2/payment-accounts/

  • state: One of unverified, paid, notenoughbalance, cancelled, scheduled

  • direction: One of in, out

  • from_date: Filter by booking date. Format: YYYY-MM-DD. This date cannot be more than 365 days in the past.

  • to_date: Filter by booking date. Format: YYYY-MM-DD.

Request Headers:

  • Host: Must be api.psd2.holvi.com

  • Date: Must follow the format described in section 7.1.1.1 of RFC 7231

  • Signature: See authentication documentation for more details

  • X-Holvi-Client-Id: Client ID provided by Holvi

  • X-Holvi-Client-Secret: Client secret provided by Holvi

  • Authorization: JWT token to authenticate

Status Codes:

  • 200: No error

  • 401: Unsuccessful authentication

Detail#

GET /api/v2/payment-accounts/(string:payment_account_uuid)/payments/(string:payment_uuid)/#

Example response:

HTTP/1.1 200 OK
Vary: Accept
Content-Type: application/json

{
    "uuid": "c437243b-c5a8-4629-b00c-773505868f0f",
    "counterparty": {
        "name": "Holvi",
        "bic": "",
        "account_identifier": "",
        "account_identifier_type": "iban"
    },
    "amount": "10.00",
    "currency": "EUR",
    "method": "sepa",
    "booking_date": null,
    "due_date": "2024-06-26",
    "execution_at": "2024-06-26T09:40:15.994768Z",
    "state": "scheduled",
    "direction": "out",
    "is_credit": null,
    "structured_reference": "",
    "unstructured_reference": "",
    "end_to_end_id": ""
}

Parameters:

Request Headers:

  • Host: Must be api.psd2.holvi.com

  • Date: Must follow the format described in section 7.1.1.1 of RFC 7231

  • Signature: See authentication documentation for more details

  • X-Holvi-Client-Id: Client ID provided by Holvi

  • X-Holvi-Client-Secret: Client secret provided by Holvi

  • Authorization: JWT token to authenticate

Status Codes:

  • 200: No error

  • 401: Unsuccessful authentication

On this page