v1

latestOpenAPI 3.1.0Apache 2.02026-07-2498321298.8 KB

Transactions

Update transaction

Update a transaction.

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

Path parameters

idstring required

Atlar resource ID.

Headers

If-Matchstring

ETag (version) of resource to be updated.

Response

The updated transaction.

idstring required

Unique resource identifier.

organizationIdstring required

Unique resource identifier for an Organization.

accountIdstring required

The ID of the account which the transaction is booked on.

datestring date required

full-date notation as defined by RFC 3339, section 5.6, for example, 2017-07-21.

referencestring

Transaction reference. (This type of reference is sometimes also referred to as remittance information.)

reconciliationStatus'RECONCILED' | 'PARTIALLY_RECONCILED' | 'NOT_RECONCILED' required

Specifies whether the transaction have been reconciled against a payment or an expected transaction.

descriptionstring required

In most cases, the description will contain the same value (text) as the remittance information. If the remittance information lacks clarity or meaning, the description can be derived from the bank transaction code instead. This description field is intended solely for displaying a meaningful description to users.

valueDatestring date

full-date notation as defined by RFC 3339, section 5.6, for example, 2017-07-21.

returnedboolean required

Whether or not the transaction is considered a return or reversal.

createdstring date-time required

Time at which the resource was created.

updatedstring date-time required

Time at which the resource was last updated.

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.

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.

Example response

{
  "id": "2ed9a3ee-60aa-4f9f-a858-2eed4eefbbc8",
  "organizationId": "0160f6ab-5741-49e1-af46-9138927e547e",
  "accountId": "31d593d7-fff9-4783-aa1d-92acb7b21a19",
  "date": "2022-05-07",
  "amount": {
    "currency": "EUR",
    "stringValue": "15.02",
    "value": 1502
  },
  "reference": "invoice-2022-05-03-012345",
  "references": {
    "mandateReference": "123456",
    "endToEndId": "123456",
    "bankTransactionReference": "123456"
  },
  "reconciliationStatus": "RECONCILED",
  "counterparty": {
    "partyType": "INDIVIDUAL",
    "name": "Customer #312",
    "nationalIdentifier": {
      "type": "CIVIC",
      "market": "DE",
      "number": "2012121212"
    },
    "address": {
      "country": "DE",
      "countrySubdivision": "US-CA",
      "city": "Stockholm",
      "postalCode": "11111",
      "streetName": "Example street",
      "streetNumber": "47"
    },
    "account": {
      "market": "DE",
      "identifiers": [
        {
          "type": "IBAN",
          "market": "DE",
          "number": "DE75512108001245126199"
        }
      ],
      "routing": [
        {
          "type": "BIC",
          "number": "BUKBGB22"
        }
      ]
    }
  },
  "description": "Invoice #123",
  "instructedAmount": {
    "currency": "EUR",
    "stringValue": "15.02",
    "value": 1502
  },
  "bankTransactionCode": {
    "domain": "PMNT",
    "family": "IDDT",
    "subfamily": "ESCT",
    "description": "SEPA Credit Transfer"
  },
  "valueDate": "2022-05-07",
  "returnReason": {
    "originalBankTransactionCode": {
      "domain": "PMNT",
      "family": "IDDT",
      "subfamily": "ESCT",
      "description": "SEPA Credit Transfer"
    }
  },
  "currencyExchange": {
    "sourceCurrency": "EUR",
    "targetCurrency": "SEK",
    "unitCurrency": "EUR",
    "exchangeRate": "11.21320"
  },
  "charges": [
    {
      "amount": {
        "currency": "EUR",
        "stringValue": "15.02",
        "value": 1502
      },
      "type": "BATCH",
      "chargeBearer": "SHARED",
      "included": "INCLUDED"
    }
  ],
  "virtualAccount": {
    "market": "DE",
    "identifiers": [
      {
        "type": "IBAN",
        "market": "DE",
        "number": "DE75512108001245126199"
      }
    ],
    "routing": [
      {
        "type": "BIC",
        "number": "BUKBGB22"
      }
    ]
  },
  "batchInformation": {
    "transactionCount": 10,
    "totalAmount": {
      "value": 100000,
      "stringValue": "1000.00",
      "currency": "EUR"
    }
  },
  "attachedTransactables": [
    {
      "type": "CREDIT_TRANSFER",
      "id": "1828d825-3f40-48c2-9b3b-07017ff887cc"
    }
  ],
  "internalTransfer": {
    "internalTransferId": "2ed9a3ee-60aa-4f9f-a858-2eed4eefbbc8",
    "counterpartTransactionId": "2ed9a3ee-60aa-4f9f-a858-2eed4eefbbc8",
    "counterpartAccountId": "2ed9a3ee-60aa-4f9f-a858-2eed4eefbbc8"
  },
  "created": "2022-05-04T18:31:12.889104898Z",
  "updated": "2022-05-04T18:47:32.213842599Z",
  "version": 1,
  "etag": "version:3",
  "metadata": {
    "my_metadata_key": "2a9a79b9-601c-449b-aa05-432f41dbbc4a"
  }
}