One or many of these objects is passed in when using the New Payer and Update Payer endpoints.
Field Name | Type | Description |
|---|---|---|
firstName | String | The Payer's first name. One of either firstName, lastName, or businessName is required. |
lastName | String | The Payer's last name. One of either firstName, lastName, or businessName is required. |
businessName | String | The Payer's business name. One of either firstName, lastName, or businessName is required. |
payerName | Integer | eNum 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". |
emails | Array of Strings | Allows for 1 or many email addresses to be added to the payer record. |
payerAddress | Object/Hash | Object 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"
}
}