Get Payor

{
  "type": "object",
  "required": [
    "payorId",
    "payorName"
  ],
  "properties": {
    "address": {
      "type": "object",
      "required": [
        "city",
        "country",
        "line1"
      ],
      "properties": {
        "city": {
          "type": "string"
        },
        "country": {
          "type": "string"
        },
        "countyOrProvince": {
          "type": "string"
        },
        "line1": {
          "type": "string"
        },
        "line2": {
          "type": "string"
        },
        "line3": {
          "type": "string"
        },
        "line4": {
          "type": "string"
        },
        "zipOrPostcode": {
          "type": "string"
        }
      }
    },
    "allowsLanguageChoice": {
      "type": "boolean",
      "description": "Whether or not the payor allows language choice in the UI."
    },
    "collectiveAlias": {
      "type": "string",
      "description": "How the payor has chosen to refer to payees."
    },
    "dbaName": {
      "type": "string",
      "description": "The payor’s 'Doing Business As' name."
    },
    "includesReports": {
      "type": "boolean"
    },
    "kycState": {
      "type": "string",
      "description": "The kyc state of the payor. One of the following values: FAILED_KYC, PASSED_KYC, REQUIRES_KYC"
    },
    "language": {
      "type": "string",
      "description": "The payor’s language preference. Must be one of [EN, FR]"
    },
    "managingPayees": {
      "type": "boolean"
    },
    "manualLockout": {
      "type": "boolean",
      "description": "Whether or not the payor has been manually locked by the backoffice."
    },
    "maxMasterPayorAdmins": {
      "type": "integer"
    },
    "openBankingEnabled": {
      "type": "boolean",
      "description": "Is Open Banking supported for this payor"
    },
    "payeeGracePeriodDays": {
      "type": "integer",
      "description": "The grace period for paying payees in days."
    },
    "payeeGracePeriodProcessingEnabled": {
      "type": "boolean",
      "description": "Whether grace period processing is enabled."
    },
    "paymentRails": {
      "type": "string",
      "description": "The id of the payment rails"
    },
    "payorId": {
      "type": "string",
      "format": "uuid"
    },
    "payorName": {
      "type": "string",
      "description": "The name of the payor."
    },
    "payorXid": {
      "type": "string",
      "description": "A unique identifier that an external system uses to reference the payor in their system"
    },
    "primaryContactEmail": {
      "type": "string",
      "format": "email",
      "description": "Primary contact email for the payor."
    },
    "primaryContactName": {
      "type": "string",
      "description": "Name of primary contact for the payor."
    },
    "primaryContactPhone": {
      "type": "string",
      "description": "Primary contact phone number for the payor."
    },
    "provider": {
      "type": "string",
      "description": "The source of the payorXid, default is null which means Velo"
    },
    "reminderEmailsOptOut": {
      "type": "boolean",
      "description": "Whether or not the payor has opted-out of reminder emails being sent."
    },
    "remoteSystemIds": {
      "type": "array",
      "description": "The payor’s supported remote systems by id",
      "items": {
        "type": "string"
      }
    },
    "supportContact": {
      "type": "string",
      "description": "The payor’s support contact email address."
    },
    "transmissionTypes": {
      "type": "object",
      "required": [
        "ACH",
        "SAME_DAY_ACH",
        "WIRE"
      ],
      "properties": {
        "ACH": {
          "type": "boolean",
          "description": "Whether the Payor is allowed to pay via ACH"
        },
        "SAME_DAY_ACH": {
          "type": "boolean",
          "description": "Whether the Payor is allowed to pay via same day ACH"
        },
        "WIRE": {
          "type": "boolean",
          "description": "Whether the Payor is allowed to pay via wire"
        }
      }
    },
    "usdTxnValueReportingThreshold": {
      "type": "integer",
      "description": "USD in minor units"
    },
    "wuCustomerId": {
      "type": "string"
    }
  }
}