--- title: "Update counterparty" method: PATCH path: "/payments/v2/counterparties/{id}" tags: ["Counterparties"] --- # Update counterparty `PATCH /payments/v2/counterparties/{id}` Update a counterparty. ## Path parameters - `id` string, required ## Headers - `If-Match` string ## Response `200` The updated counterparty. - Counterparty — A counterparty represents a person or a legal business entity. - `id` string, required — Unique resource identifier. - `organizationId` string, required — Unique resource identifier for an Organization. - `legalName` string, 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 - `alias` string — An additional name, an alias, for the counterparty. - `address` Address — Postal address. - `country` string — Two-letter ISO 3166-1 alpha2 country code. - `countrySubdivision` string — Country subdivision code (second part of the ISO 3166-2 code). E.g. state code `CA` for the state of California in the USA, `ON` for the province of Ontario in Canada, `NSW` for the state of New South Wales in Australia. ISO 3166-2 codes can be found on the ISO website, for example, for the USA: https://www.iso.org/obp/ui/#iso:code:3166:US. In the USA the state code is required for domestic payments, in Canada the province code is required for domestic payments. - `city` string - `postalCode` string - `streetName` string - `streetNumber` string - `accounts` ExternalAccount[] - `id` string, required — Unique resource identifier. - `organizationId` string, required — Unique resource identifier for an Organization. - `counterpartyId` string, required — The ID of the counterparty to which this external account belongs. - `entityIds` ResourceID[] - `market` string, required — Two-letter ISO 3166-1 alpha2 country code. - `name` string, required — Name of the account. This is a read-only derived property. It will take the value of `alias` if `alias` is set, otherwise it will be a display name derived from the account number(s). - `alias` string — An additional name, an alias, for the account. - `identifiers` AccountIdentifier[], required - `type` 'IBAN' | 'NUMBER' | 'ADYEN' | 'AU_BPAY_BILLER_CODE' | 'DK_FIK' | 'INVESTMENT_NUMBER' | 'NATIONAL_ID_NUMBER' | 'PAYPAL' | 'PROPRIETARY' | 'SE_BANKGIRO' | 'SE_PLUSGIRO' | 'SOLDO' | 'WALLET_ADYEN_BALANCE_PLATFORM' | 'WALLET_AIRWALLEX' | 'WALLET_CURRENCYCLOUD' | 'WALLET_FLASH_PAYMENTS' | 'WALLET_FREEMARKET' | 'WALLET_HYPERWALLET' | 'WALLET_INPAY' | 'WALLET_LEAD' | 'WALLET_MERCURY' | 'WALLET_MONEYCORP' | 'WALLET_PAYHAWK' | 'WALLET_REVOLUT' | 'WALLET_SKRILL' | 'WALLET_STRIPE' | 'WALLET_SWISSQUOTE', required — Account Identifier type. Choose among: For further information please refer to Account Identifiers - `market` string, required — Two-letter ISO 3166-1 alpha2 country code. - `number` string, required — The unformatted identifier itself. For type `NUMBER` the structure of the account number is country-specific. - `invalid` boolean — Will be `true` if the account identifier is invalid according to Atlar account identifier validation rules. - `routing` RoutingIdentifier[] - `type` 'BIC' | 'AT_BLZ' | 'AU_BSB' | 'BR_BRANCH' | 'BR_COMPE' | 'BR_ISP' | 'CA_CPA' | 'CH_BCC' | 'CH_SIC' | 'CL_SBIF' | 'CN_APS' | 'DE_BLZ' | 'ES_NCC' | 'GB_DSC' | 'GR_BIC' | 'HK_NCC' | 'IE_NCC' | 'IL_NCC' | 'IN_FSC' | 'IT_NCC' | 'JP_ZGN' | 'KR_BOK' | 'KR_KFTC' | 'MX_ABM' | 'MY_NCC' | 'NZ_NCC' | 'PL_KNR' | 'PT_NCC' | 'RU_CBC' | 'SE_SBA' | 'SG_IBG' | 'TH_CBC' | 'TW_NCC' | 'US_ABA' | 'US_PID' | 'VN_CITAD' | 'ZA_NCC', required — A routing identifier of type `BIC` must be provided to support cross-border/SWIFT payments. - `number` string, required — The form of the routing number depends on `type`. E.g. for `BIC` the value should be an 8 or 11 character BIC/SWIFT code. For `GB_DSC` (UK domestic routing) the value should be a six digit sort code. - `invalid` boolean — Will be `true` if the routing identifier is invalid according to Atlar validation rules. - `constraints` RoutingConstraints — Constraints on a `RoutingIdentifier`. - `accountNumberType` 'IBAN' | 'NUMBER' | 'ADYEN' | 'AU_BPAY_BILLER_CODE' | 'DK_FIK' | 'INVESTMENT_NUMBER' | 'NATIONAL_ID_NUMBER' | 'PAYPAL' | 'PROPRIETARY' | 'SE_BANKGIRO' | 'SE_PLUSGIRO' | 'SOLDO' | 'WALLET_ADYEN_BALANCE_PLATFORM' | 'WALLET_AIRWALLEX' | 'WALLET_CURRENCYCLOUD' | 'WALLET_FLASH_PAYMENTS' | 'WALLET_FREEMARKET' | 'WALLET_HYPERWALLET' | 'WALLET_INPAY' | 'WALLET_LEAD' | 'WALLET_MERCURY' | 'WALLET_MONEYCORP' | 'WALLET_PAYHAWK' | 'WALLET_REVOLUT' | 'WALLET_SKRILL' | 'WALLET_STRIPE' | 'WALLET_SWISSQUOTE' — Account Identifier type. Choose among: For further information please refer to Account Identifiers - `scheme` string - `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` Metadata, 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](https://app.atlar.com/metadata-keys). 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. - `created` string, date-time, required — Time at which the resource was created. - `updated` string, date-time, required — Time at which the resource was last updated. - `version` integer, required — Resource version. Starts at value `1` when the resource is created and increases by one for each successive update. - `etag` string, required — [ETag](https://en.wikipedia.org/wiki/HTTP_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. - `email` string — Email of the counterparty. - `phone` string — Phone number of the counterparty. - `nationalIdentifier` NationalIdentifier - `type` 'CIVIC' | 'COMPANY', required — Type of the national identifier. - `market` string, required — Two-letter ISO 3166-1 alpha2 country code. - `number` string, required — The identifier itself. - `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` Metadata, 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](https://app.atlar.com/metadata-keys). 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. - `created` string, date-time, required — Time at which the resource was created. - `updated` string, date-time, required — Time at which the resource was last updated. - `version` integer, required — Resource version. Starts at value `1` when the resource is created and increases by one for each successive update. - `etag` string, required — [ETag](https://en.wikipedia.org/wiki/HTTP_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. - `entityIds` ResourceID[] — 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. ## Other responses - `400` — Bad request. - `404` — Resource not found. --- [API](https://skmtc.net/atlar/apis/atlar-api-v2.md) · [All operations](https://skmtc.net/atlar/apis/atlar-api-v2/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/atlar/atlar-api-v2/versions/9c5e194ccf5d/schema)