counterparty_update_request

FintechPaymentsACHWiresTreasury

Properties

Name	Type	Description
name	string	A new name for the counterparty. Will only update if passed.
email	string	A new email for the counterparty.
metadata	object	Additional data in the form of key-value pairs. Pairs can be removed by passing an empty string or `null` as the value.
send_remittance_advice	boolean	If this is `true`, Modern Treasury will send an email to the counterparty whenever an associated payment order is sent to the bank.
legal_entity_id	string	The id of the legal entity.
taxpayer_identifier	string	Either a valid SSN or EIN.
external_id	string	An optional user-defined 180 character unique identifier.

View JSON Schema on GitHub

JSON Schema

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "#/components/schemas/counterparty_update_request",
  "title": "counterparty_update_request",
  "type": "object",
  "properties": {
    "name": {
      "type": "string",
      "description": "A new name for the counterparty. Will only update if passed."
    },
    "email": {
      "type": "string",
      "format": "email",
      "description": "A new email for the counterparty."
    },
    "metadata": {
      "type": "object",
      "additionalProperties": {
        "type": "string"
      },
      "description": "Additional data in the form of key-value pairs. Pairs can be removed by passing an empty string or `null` as the value."
    },
    "send_remittance_advice": {
      "type": "boolean",
      "description": "If this is `true`, Modern Treasury will send an email to the counterparty whenever an associated payment order is sent to the bank."
    },
    "legal_entity_id": {
      "type": "string",
      "format": "uuid",
      "description": "The id of the legal entity.",
      "nullable": true
    },
    "taxpayer_identifier": {
      "type": "string",
      "description": "Either a valid SSN or EIN."
    },
    "external_id": {
      "type": "string",
      "description": "An optional user-defined 180 character unique identifier.",
      "nullable": true
    }
  }
}