v1

latestOpenAPI 3.1.0Apache 2.02026-07-2498321298.8 KB

Accounts

Update account

Update an account.

patch/financial-data/v2/accounts/{id}

Path parameters

idstring required

Atlar resource ID.

Headers

If-Matchstring

ETag (version) of resource to be updated.

Response

The updated account.

idstring required

Unique resource identifier.

organizationIdstring required

Unique resource identifier for an Organization.

thirdPartyIdstring required

ID of the associated third-party, e.g. the bank in which the account is held.

affiliationIdstring required

ID of the affiliation. An affiliation is and describes the relationship between the legal entity (entityId) owning this account and the third-party (thirdPartyId) where the account is held (e.g. a bank).

entityIdstring required

ID of the associated legal Entity.

marketstring required

Two-letter ISO 3166-1 alpha2 country code.

currencystring required

Three-letter ISO 4217 currency code.

namestring required

Name of the account automatically populated by Atlar.

aliasstring

An additional name, an alias, for the account.

type'WALLET' | 'SAVINGS' | 'CHECKING' | 'INVESTMENT'

status'OPEN' | 'CLOSED' required

Operational status of the account with the holding financial institution.

fictiveboolean required

Indicates whether the account is a fictive/test account. This will be true for accounts associated with the Atlar Testbank.

externalIdstring

External ID is optional to use, but if used, the Atlar platform will persist it, index it, as well as require it to be unique across all resources. It is possible to retrieve a resource using the external ID using the prefix external:.

metadataMetadata nullable

Metadata is a string-string key-value container that can be used to store information known at the time of resource creation. This can be retrieved later on, for instance when a payment or expected transaction is reconciled with the booked transaction on the bank statement.

Metadata can have at most 20 entries. Keys may have a maximum length of 64 chars and values a maximum length of 512 chars.

By default, this field is optional. It is possible to make it required in the Atlar Dashboard by visiting the Metadata keys page. Requirement rules can be specified per API resource. Both the Dashboard and the API will then enforce these rules and give validation errors when the required fields are not set.

versioninteger required

Resource version. Starts at value 1 when the resource is created and increases by one for each successive update.

etagstring required

ETag based on the resource version. This can be passed along in If-Match HTTP header when updating a resource to perform a conditional update.

createdstring date-time required

Time at which the resource was created.

updatedstring date-time required

Time at which the resource was last updated.

closedstring date-time

Time at which the account was closed. Only present if account status is CLOSED.

provisionState'UNPROVISIONED' | 'IGNORED' | 'PROVISIONED' required

Example response

{
  "id": "2ed9a3ee-60aa-4f9f-a858-2eed4eefbbc8",
  "organizationId": "0160f6ab-5741-49e1-af46-9138927e547e",
  "thirdPartyId": "0a951c88-3313-472a-b312-ca2e47769670",
  "affiliationId": "b9a931ce-9606-495d-95b0-8da8251c008a",
  "entityId": "b130e3d7-f67c-4a10-b359-25ad88c4999b",
  "market": "DE",
  "currency": "EUR",
  "name": "My Business Account",
  "alias": "My Business Account",
  "identifiers": [
    {
      "type": "IBAN",
      "market": "DE",
      "number": "DE75512108001245126199"
    }
  ],
  "routing": [
    {
      "type": "BIC",
      "number": "BUKBGB22"
    }
  ],
  "status": "OPEN",
  "externalId": "walVNuin6X5Mvte4xhg1ibTAVSACfN4Q9hl",
  "metadata": {
    "my_metadata_key": "2a9a79b9-601c-449b-aa05-432f41dbbc4a"
  },
  "paymentOptions": {
    "instruments": [
      {
        "type": "CITI_WORLDLINK",
        "citiWorldlinkId": "123456789"
      }
    ]
  },
  "version": 1,
  "etag": "version:3",
  "created": "2022-05-04T18:31:12.889104898Z",
  "updated": "2022-05-04T18:47:32.213842599Z"
}