Customer

Add customer

Creates a customer in an entrypoint. An identifier is required to create customer records. Change your identifier settings in Settings > Custom Fields in the Payabli Portal. If you don't include an identifier, the record is rejected.

post/Customer/single/{entry}

Request

  • Base URL: https://api-sandbox.payabli.com/api
  • URL: https://api-sandbox.payabli.com/api/Customer/single/{entry}
  • Auth: HTTP bearer

Path parameters

entrystring required

The entrypoint identifier.

Query parameters

forceCustomerCreationboolean

When true, the request creates a new customer record, regardless of whether customer identifiers match an existing customer.

replaceExistinginteger

Flag indicating to replace existing customer with a new record. Possible values: 0 (don't replace), 1 (replace). Default is 0.

Headers

idempotencyKeystring

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 isn't generated in Payabli; you must generate it yourself. The key persists for 2 minutes. After 2 minutes, you can reuse the key if needed.

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 isn't generated in Payabli, you must generate it yourself. This key persists for 2 minutes. After 2 minutes, you can reuse the key if needed.

Request body

customerNumberstring

User-provided unique identifier for the customer. This is typically the customer ID from your own system.

customerUsernamestring

Customer username for customer portal

customerPswstring

Customer password for customer portal

customerStatusinteger

Customer Status. Possible values:

  • -99 Deleted
  • 0 Inactive
  • 1 Active
  • 85 Locked (typically due to multiple failed login attempts)
companystring

Company name

firstnamestring

Customer first name

lastnamestring

Customer last name

phonestring

Customer phone number. Payabli normalizes this value when it's stored. For example, (555) 555-0100 is stored as +15555550100.

emailstring email

Email address.

addressstring

Customer address

address1string

Additional customer address

citystring

Customer city

statestring

Customer State

zipstring

Customer postal code

countrystring

Customer country in ISO-3166-1 alpha 2 format. See https://en.wikipedia.org/wiki/ISO_3166-1 for reference.

shippingAddressstring

The shipping address.

shippingAddress1string

Additional line for shipping address.

shippingCitystring

Shipping city.

shippingStatestring

Shipping state or province.

shippingZipstring

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.

shippingCountrystring

Shipping address country.

balancenumber double

Customer balance.

timeZoneinteger

Timezone, in UTC offset. For example, -5 is Eastern time.

additionalFieldsobject

Additional Custom fields in format "key":"value".

identifierFieldsstring[]

List of fields acting as customer identifiers, to be used instead of CustomerNumber.

createdAtstring date-time

Timestamp of when record was created, in UTC.

Response

Success

isSuccessboolean

Boolean indicating whether the operation was successful. A true value indicates success. A false value indicates failure.

responseTextstring required

Response text for operation: 'Success' or 'Declined'.

Changes

No recorded changes to this operation across all 1 revision of this API.