Provides access to customers registered within the system.
Resource URL | Description |
---|---|
https://portaldev.eonpayments.com/api/v01/customers/[customer-id] | Provides access to configuration settings for the specified customer. |
Method: PUT | Implicit: Yes | Returns: Customer * |
Consumes: json, xml | Produces: json, xml | |
Create new customer record for recurring billing.
- Records include name, address, payment options, and subscription plan connections. - Only create customers when using the Recurring Billing API. - Do not create customers for non-recurring transactions through the Transaction API. - A customer can have multiple payment methods and subscription plans for flexible billing models. |
# | Name | Type | Required | Default | Description |
---|---|---|---|---|---|
01 | object | Customer * | Yes |
Represents information about the customer. |
Method: GET | Implicit: Yes | Returns: Customer[] * |
Consumes: xurl | Produces: json, xml | |
Returns a list of available customers based on specified search criteria.
|
# | Name | Type | Required | Default | Description |
---|---|---|---|---|---|
01 | offset | Integer | No | 0 |
Index of the first record returned from the search result.\n\r\n> **Note:** Default: `0`. Used with limit parameter for pagination.\n\r\n> **Tip:** Use this field for implementing paginated results. |
02 | limit | Integer | No | 100 |
Maximum number of records to load per search call.\n\r\n> **Note:** Default: `100`. Adjust based on performance requirements.\n\r\n> **Tip:** Use this field to balance response size and performance. |
03 | accountId | Integer | No |
Specifies which merchant account to use with this API call.\n\r\n> **Note:** Your API credentials may be associated with more than one accountId.\n\r\n> **Tip:** When working with multiple merchant accounts, use this field to ensure transactions are processed against the correct account. |
|
04 | firstName | String(125) | No |
First name of the customer. This field applies to both individual and organization-type customers.\n\r\n> **Note:** For organizations, this field is used for the first name of the company's contact person. |
|
05 | lastName | String(125) | No |
Last name of the customer. This field applies to both individual and organization-type customers.\n\r\n> **Note:** For organizations, this field is used for the last name of the company's contact person. |
|
06 | organizationName | String(255) | No |
Name of the organization associated with the customer.\n\r\n> **Note:** This is a user-provided freeform field and does not represent any other data structure or object. |
|
07 | String(100) | No |
Email associated with the customer.\n\r\n> **Tip:** Providing an email address enables automatic notifications and improves customer communication capabilities. |
||
08 | phone | String(15) | No |
Phone number of the customer.\n\r\n> **Note:** Include country code for international numbers. |
|
09 | street | String(128) | No |
Street of the mailing address of the customer used for filtering Customer records. |
|
10 | city | String(50) | No |
The city of the customer.\n\r\n> **Tip:** Including complete address information may lower interchange costs for certain transaction types. |
|
11 | state | String(3) | No |
The state of the customer.\n\r\n> **Note:** State format is subject to the associated country code. For US addresses, use two-letter state codes. |
|
12 | zipCode | String(10) | No |
The ZIP or postal code of the customer.\n\r\n> **Note:** Format is subject to the associated country code in the Customer object. |
|
13 | countryCode | String(2) | No |
The country code of the customer's address.\n\r\n> **Note:** Use ISO 3166-1 alpha-2 standard. Example: US for United States, CA for Canada. |