Skip to main content
POST
/
v1
/
accounts
Batch import of account entries
curl --request POST \
  --url https://api.vop-sandbox.finventi.com/v1/accounts \
  --header 'Content-Type: application/json' \
  --header 'Idempotency-Key: <idempotency-key>' \
  --data '
{
  "accounts": "[{iban: LT121000011101001000, account_holder_names: [Alice Johnson]}]"
}
'
{
  "failed_count": 15,
  "failed_entries": {
    "account_holder_names": [
      "Alice Johnson"
    ],
    "aliases": [
      "<string>"
    ],
    "reasons": [
      "IBAN is required and cannot be empty"
    ],
    "client_id": "client-12345",
    "iban": "LT121000011101001000",
    "organisation_identification": {
      "bic": "DEUTDEFFXXX",
      "lei": "5493001KJTIIGC8Y1R12",
      "other": {
        "identification": "123-ABC-XYZ",
        "issuer": "ChamberOfCommerce",
        "scheme_name_code": "VAT",
        "scheme_name_proprietary": "LocalRegistry"
      }
    }
  },
  "imported_count": 85,
  "imported_entries": {
    "account_holder_names": [
      "Alice Johnson"
    ],
    "aliases": [
      "HGRP"
    ],
    "iban": "LT121000011101001000",
    "client_id": "client-12345",
    "organisation_identification": {
      "bic": "DEUTDEFFXXX",
      "lei": "5493001KJTIIGC8Y1R12",
      "other": {
        "identification": "123-ABC-XYZ",
        "issuer": "ChamberOfCommerce",
        "scheme_name_code": "VAT",
        "scheme_name_proprietary": "LocalRegistry"
      }
    }
  },
  "total_count": 100
}

Headers

​
Idempotency-Key
string
required

Unique idempotency key to prevent duplicate batch account import requests

Body

application/json

Batch import request containing account entries

​
accounts
object
required

Payload for importing a single account via IBAN and owner identification.

Example:

"[{iban: LT121000011101001000, account_holder_names: [Alice Johnson]}]"

Response

Response returned after a batch account import operation

Response returned after a batch account import operation

​
failed_count
integer<int32>
required

Number of account entries that failed to import

Example:

15

​
failed_entries
object
required

List of account entries that failed to be imported along with reasons

​
imported_count
integer<int32>
required

Number of account entries successfully imported

Example:

85

​
imported_entries
object
required

List of account entries that were successfully imported

​
total_count
integer<int32>
required

Total number of account entries submitted for import

Example:

100