SIsilverflow
Agents

Update Agent

Requires agents:Update permission.

patch/agents/{agentKey}

Request

Path parameters

agentKeystring required

Uniquely identifies an Agent

Example:cgt-1UF2NafdfrdPMf2XrS2

Uniquely identifies an Agent. When called by an Agent the literal value "current" can be used instead of the actual Agent Key.

Headers

If-Matchinteger

The request condition

Request body

descriptionstring

A description of the Agent

technicalEmailsEmail[]

A list of email addresses.

billingEmailsEmail[]

A list of email addresses.

settlementEmailsEmail[]

A list of email addresses.

businessEmailsEmail[]

A list of email addresses.

Response

successful operation

keystring required

Uniquely identifies an Agent

status'idle' | 'active' | 'archived' required

The status of an Agent

namestring required

The display name of the Agent

descriptionstring

A description of the Agent

legalNamestring required

The legal name of the Agent

vatIdstring

VAT identification number of the Agent

binKeysBinKey[] required
acquirerSegmentIdnumber

VAU acquirer segment identifier

technicalEmailsEmail[] required

A list of email addresses.

billingEmailsEmail[] required

A list of email addresses.

settlementEmailsEmail[] required

A list of email addresses.

businessEmailsEmail[]

A list of email addresses.

createdstring date-time required

The date and time this object was created

lastModifiedstring date-time

The date and time this object was last modified

versioninteger required

The version of this object

Example response

{
  "key": "cgt-1UF2NafdfrdPMf2XrS2",
  "billingAddress": {
    "countryCode": {
      "alpha3": "NLD",
      "alpha2": "NL",
      "numeric": "528"
    },
    "stateOrProvince": "Noord-Holland",
    "city": "Amsterdam-Duivendrecht",
    "line1": "Entrada 300",
    "line2": "Floor 3",
    "postalCode": "1114 AA"
  },
  "registeredAddress": {
    "countryCode": {
      "alpha3": "NLD",
      "alpha2": "NL",
      "numeric": "528"
    },
    "stateOrProvince": "Noord-Holland",
    "city": "Amsterdam-Duivendrecht",
    "line1": "Entrada 300",
    "line2": "Floor 3",
    "postalCode": "1114 AA"
  }
}

Changes

No recorded changes to this operation across all 1 revision of this API.