Create counterparty

post

https://api.atlar.com/payments/v2/counterparties

Create a new counterparty.

Body Params

legalName

string

required

length ≤ 96

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

alias

string

length ≤ 255

An additional name, an alias, for the counterparty.

partyType

string

enum

The legal type of a party

Allowed:

address

object

Address details for the counterparty.

string

length ≤ 256

Email of the counterparty.

phone

string

length ≤ 64

Phone number of the counterparty.

accounts

array of objects

An optional list of external accounts to create for this counterparty. Note that external account is a separate API resource. One counterparty can have multiple external accounts.

accounts

externalId

string

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:.

metadata

object | null

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.

nationalIdentifier

object

The national identifier of the counterparty.

entityIds

array of objects

length ≤ 100

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.

entityIds

Responses

201The created counterparty.

400Bad request.