Create customer
Creates a customer in an entrypoint. An identifier is required to create customer records. Change your identifier settings in Settings > Custom Fields in PartnerHub. If you don’t include an identifier, the record is rejected.
Path parameters
The entrypoint identifier.
Headers
Optional but recommended A unique ID that you can include to prevent duplicating objects or transactions in the case that a request is sent more than once. This key is not generated in Payabli, you must generate it yourself.
Query parameters
When true, the request creates a new customer record, regardless of whether customer identifiers match an existing customer.
Flag indicating to replace existing customer with a new record Possible values: 0(do not replace), 1(replace). Default is “0”
Request
Additional Custom fields in format “key”:“value”.
Customer address
Additional customer address
Customer balance.
Customer city
Company name
Customer country in ISO-3166-1 alpha 2 format
See https://en.wikipedia.org/wiki/ISO_3166-1 for reference.
Timestamp of when record was created, in UTC.
User-provided unique identifier for the customer. This is typically the customer ID from your own system.
Customer password for customer portal
Customer Status. Possible values:
-99Deleted0Inactive1Active85Locked (typically due to multiple failed login attempts)
Customer username for customer portal
Customer email address.
Customer first name
List of fields acting as customer identifiers, to be used instead of CustomerNumber.
Customer last name
Customer phone number
The shipping address.
Additional line for shipping address.
Shipping city.
Shipping address country.
Shipping state or province.
Shipping ZIP code. For Pay In functions, this field supports 5-digit and 9-digit ZIP codes and alphanumeric Canadian postal codes. For example: “37615-1234” or “37615”.
Customer State
Timezone, in UTC offset. For example, -5 is Eastern time.
Customer zip code
Response
Success
Boolean indicating whether the operation was successful. A true value indicates success. A false value indicates failure.
Response text for operation: ‘Success’ or ‘Declined’.