One or many of these objects is passed in when using the New Payer and Update Payer endpoints.

Field NameTypeDescription
firstNameStringThe Payer's first name. One of either firstName, lastName, or businessName is required.
lastNameStringThe Payer's last name. One of either firstName, lastName, or businessName is required.
businessNameStringThe Payer's business name. One of either firstName, lastName, or businessName is required.
payerNameIntegereNum values 1-3 determine what format the payer name will be displayed as within the application. 1= "First Last", 2="Business Name", 3="First Last | Business Name".
emailsArray of StringsAllows for 1 or many email addresses to be added to the payer record.
payerAddressObject/HashObject that includes all of the payer's address information. For more information, see the payer address object.
"payer": {
    "firstName": "Jack",
    "lastName": "Wyman",
    "businessName": "Wyman Corp.",
    "payerName": "firstLast",
    "emails": [
      "[email protected]"
    ],
    "payerAddress": {
      "addressLine1": "123 Main St",
      "phoneNumber": "123-123-1234",
      "city": "Shreveport",
      "state": "LA",
      "zipCode": "71101"
    }
  }