ATatlar
Connections

Create report

Changed on

Create a report. This is used for manual upload of data. For instance if having raw camt.053/mt940 files but not wanting to set up a connection to automatically fetch them, or, if the atlar/third-party does not support fetching of the data.

post/connectivity/v2beta/connections/{cid}/reports

Request

Path parameters

cidstring required

Atlar connection ID.

Request body

Example request

{
  "statements": [
    {
      "period": {
        "localDate": "2022-05-07"
      },
      "account": {
        "market": "DE",
        "timezone": "Europe/London",
        "currency": "EUR",
        "identifiers": [
          {
            "type": "IBAN",
            "market": "DE",
            "number": "DE75512108001245126199"
          }
        ],
        "routing": [
          {
            "type": "BIC",
            "number": "BUKBGB22"
          }
        ]
      },
      "holder": {
        "partyType": "INDIVIDUAL",
        "address": {
          "country": "DE",
          "countrySubdivision": "US-CA",
          "city": "Stockholm",
          "postalCode": "11111",
          "streetName": "Example street",
          "streetNumber": "47"
        },
        "nationalIdentifier": {
          "type": "CIVIC",
          "market": "DE",
          "number": "2012121212"
        }
      },
      "balances": [
        {
          "amount": {
            "currency": "EUR",
            "value": 1502
          },
          "localDate": "2022-05-07"
        }
      ],
      "transactions": [
        {
          "amount": {
            "currency": "EUR",
            "value": 1502
          },
          "bookedDate": "2022-05-07",
          "valueDate": "2022-05-07",
          "counterparty": {
            "holder": {
              "partyType": "INDIVIDUAL",
              "address": {
                "country": "DE",
                "countrySubdivision": "US-CA",
                "city": "Stockholm",
                "postalCode": "11111",
                "streetName": "Example street",
                "streetNumber": "47"
              },
              "nationalIdentifier": {
                "type": "CIVIC",
                "market": "DE",
                "number": "2012121212"
              }
            },
            "account": {
              "market": "DE",
              "currency": "EUR",
              "identifiers": [
                {
                  "type": "IBAN",
                  "market": "DE",
                  "number": "DE75512108001245126199"
                }
              ],
              "routing": [
                {
                  "type": "BIC",
                  "number": "BUKBGB22"
                }
              ]
            }
          },
          "instructedAmount": {
            "currency": "EUR",
            "value": 1502
          },
          "bankTransactionCode": {
            "domain": "PMNT",
            "family": "IDDT",
            "subfamily": "ESCT",
            "description": "SEPA Credit Transfer"
          }
        }
      ]
    }
  ]
}

Response

The created report.

organizationIdstring required

Unique resource identifier for an Organization.

connectionIdstring required

Unique resource identifier.

idstring required

Unique resource identifier.

convertedboolean required
thirdPartyCodesstring[]

The third parties this report holds data for.

Typically, the bank BICs occurring in the report, for example an end-of-day report carrying several statements, each reporting for one BIC. Reports from parties without a BIC, such as PSPs and ERPs, use a synthetic code instead, for example PSP_AIRWALLEX.

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.

Example response

{
  "organizationId": "0160f6ab-5741-49e1-af46-9138927e547e",
  "connectionId": "2ed9a3ee-60aa-4f9f-a858-2eed4eefbbc8",
  "id": "2ed9a3ee-60aa-4f9f-a858-2eed4eefbbc8",
  "content": {
    "contentType": "application/vnd.iso20022.camt.053.001.02+xml",
    "size": 4711,
    "checksum": "sha256:08343d976a896e8563b4915c84878207199b5fa139d3edde1bd77d99339bd18c",
    "name": "camt053_20240105.xml"
  },
  "metadata": {
    "my_metadata_key": "2a9a79b9-601c-449b-aa05-432f41dbbc4a"
  },
  "version": 1,
  "etag": "version:3",
  "created": "2022-05-04T18:31:12.889104898Z",
  "updated": "2022-05-04T18:47:32.213842599Z"
}

Changes