APIPay In endpointsCustomer

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.

Authentication

requestTokenstring
API Key authentication via header

Path Parameters

entrystringRequired<=50 characters
The entrypoint identifier.

Headers

idempotencyKeystringOptional

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.

Query Parameters

forceCustomerCreationbooleanOptionalDefaults to false

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

replaceExistingintegerOptionalDefaults to 0

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

Request

This endpoint expects an object.
customerNumberstringOptional<=250 characters

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

customerUsernamestringOptional
Customer username for customer portal
customerPswstringOptional
Customer password for customer portal
customerStatusintegerOptional
Customer Status. Possible values: - `-99` Deleted - `0` Inactive - `1` Active - `85` Locked (typically due to multiple failed login attempts)
companystringOptional
Company name
firstnamestringOptional
Customer first name
lastnamestringOptional
Customer last name
phonestringOptional
Customer phone number
emailstringOptionalformat: "email"<=320 characters
Customer email address.
addressstringOptional
Customer address
address1stringOptional
Additional customer address
citystringOptional
Customer city
statestringOptional
Customer State
zipstringOptional
Customer postal code
countrystringOptional
Customer country in ISO-3166-1 alpha 2 format. See https://en.wikipedia.org/wiki/ISO_3166-1 for reference.
shippingAddressstringOptional<=250 characters
The shipping address.
shippingAddress1stringOptional<=100 characters
Additional line for shipping address.
shippingCitystringOptional<=250 characters
Shipping city.
shippingStatestringOptional
Shipping state or province.
shippingZipstringOptional<=50 characters

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”.

shippingCountrystringOptional
Shipping address country.
balancedoubleOptional
Customer balance.
timeZoneintegerOptional

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

additionalFieldsmap from strings to optional stringsOptional

Additional Custom fields in format “key”:“value”.

identifierFieldslist of optional stringsOptional
List of fields acting as customer identifiers, to be used instead of CustomerNumber.
createdAtdatetimeOptional
Timestamp of when record was created, in UTC.

Response

Success
responseTextstring

Response text for operation: ‘Success’ or ‘Declined’.

isSuccessboolean or null

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

responseDataobject or null

Errors