v1

latestOpenAPI 3.1.0Apache 2.02026-07-2498321298.8 KB

Counterparties

Get counterparty

Retrieve a specific counterparty.

get/payments/v2/counterparties/{id}

Path parameters

idstring required

Atlar resource ID or External ID. Prefix External IDs with external:.

Response

A counterparty.

idstring required

Unique resource identifier.

organizationIdstring required

Unique resource identifier for an Organization.

legalNamestring required

Legal name of the counterparty. E.g. a company's legal business name, or an individual's full legal name.

partyType'INDIVIDUAL' | 'COMPANY'

The legal type of a party

aliasstring

An additional name, an alias, for the counterparty.

emailstring

Email of the counterparty.

phonestring

Phone number of the counterparty.

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.

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.

entityIdsResourceID[]

An optional list of entity IDs that this counterparty belongs to. If empty, the counterparty is not associated with any specific entity and can be used by all in the organization.

Example response

{
  "id": "2ed9a3ee-60aa-4f9f-a858-2eed4eefbbc8",
  "organizationId": "0160f6ab-5741-49e1-af46-9138927e547e",
  "legalName": "Example Company GmbH",
  "partyType": "INDIVIDUAL",
  "alias": "Customer #123",
  "address": {
    "country": "DE",
    "countrySubdivision": "US-CA",
    "city": "Stockholm",
    "postalCode": "11111",
    "streetName": "Example street",
    "streetNumber": "47"
  },
  "accounts": [
    {
      "id": "2ed9a3ee-60aa-4f9f-a858-2eed4eefbbc8",
      "organizationId": "0160f6ab-5741-49e1-af46-9138927e547e",
      "counterpartyId": "c151b61e-33cc-4f89-ac8d-328f9efa59e9",
      "entityIds": [
        "2ed9a3ee-60aa-4f9f-a858-2eed4eefbbc8"
      ],
      "market": "DE",
      "name": "My Business Account",
      "alias": "My Business Account",
      "identifiers": [
        {
          "type": "IBAN",
          "market": "DE",
          "number": "DE75512108001245126199"
        }
      ],
      "routing": [
        {
          "type": "BIC",
          "number": "BUKBGB22"
        }
      ],
      "externalId": "walVNuin6X5Mvte4xhg1ibTAVSACfN4Q9hl",
      "metadata": {
        "my_metadata_key": "2a9a79b9-601c-449b-aa05-432f41dbbc4a"
      },
      "created": "2022-05-04T18:31:12.889104898Z",
      "updated": "2022-05-04T18:47:32.213842599Z",
      "version": 1,
      "etag": "version:3"
    }
  ],
  "email": "john.smith@example.com",
  "phone": "+46123456789",
  "nationalIdentifier": {
    "type": "CIVIC",
    "market": "DE",
    "number": "2012121212"
  },
  "externalId": "walVNuin6X5Mvte4xhg1ibTAVSACfN4Q9hl",
  "metadata": {
    "my_metadata_key": "2a9a79b9-601c-449b-aa05-432f41dbbc4a"
  },
  "created": "2022-05-04T18:31:12.889104898Z",
  "updated": "2022-05-04T18:47:32.213842599Z",
  "version": 1,
  "etag": "version:3",
  "entityIds": [
    "2ed9a3ee-60aa-4f9f-a858-2eed4eefbbc8"
  ]
}