counterparty_collect_account_request

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "#/components/schemas/counterparty_collect_account_request",
  "title": "counterparty_collect_account_request",
  "type": "object",
  "properties": {
    "direction": {
      "type": "string",
      "enum": [
        "credit",
        "debit"
      ],
      "description": "One of `credit` or `debit`. Use `credit` when you want to pay a counterparty. Use `debit` when you need to charge a counterparty. This field helps us send a more tailored email to your counterparties.\"",
      "_x-stainless-modelDefPath": "$shared.transaction_direction"
    },
    "send_email": {
      "type": "boolean",
      "description": "By default, Modern Treasury will send an email to your counterparty that includes a link to the form they must fill out. However, if you would like to send the counterparty the link, you can set this parameter to `false`. The JSON body will include the link to the secure Modern Treasury form."
    },
    "fields": {
      "type": "array",
      "items": {
        "type": "string",
        "enum": [
          "name",
          "nameOnAccount",
          "taxpayerIdentifier",
          "accountType",
          "accountNumber",
          "ibanNumber",
          "clabeNumber",
          "walletAddress",
          "panNumber",
          "routingNumber",
          "abaWireRoutingNumber",
          "swiftCode",
          "auBsb",
          "caCpa",
          "cnaps",
          "gbSortCode",
          "inIfsc",
          "myBranchCode",
          "brCodigo",
          "routingNumberType",
          "address",
          "jpZenginCode",
          "seBankgiroClearingCode",
          "nzNationalClearingCode",
          "hkInterbankClearingCode",
          "huInterbankClearingCode",
          "dkInterbankClearingCode",
          "idSknbiCode",
          "zaNationalClearingCode"
        ]
      },
      "description": "The list of fields you want on the form. This field is optional and if it is not set, will default to [\\\"nameOnAccount\\\", \\\"accountType\\\", \\\"accountNumber\\\", \\\"routingNumber\\\", \\\"address\\\"]. The full list of options is [\\\"name\\\", \\\"nameOnAccount\\\", \\\"taxpayerIdentifier\\\", \\\"accountType\\\", \\\"accountNumber\\\", \\\"routingNumber\\\", \\\"address\\\", \\\"ibanNumber\\\", \\\"swiftCode\\\"]."
    },
    "custom_redirect": {
      "type": "string",
      "format": "uri",
      "description": "The URL you want your customer to visit upon filling out the form. By default, they will be sent to a Modern Treasury landing page. This must be a valid HTTPS URL if set."
    }
  },
  "required": [
    "direction"
  ]
}