APIPay In endpointsCustomer

Update customer

Update a customer record. Include only the fields you want to change.

Authentication

requestTokenstring
API Key authentication via header

Path parameters

customerIdintegerRequired

Payabli-generated customer ID. Maps to “Customer ID” column in PartnerHub.

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

responseCodeinteger or null

Code for the response. Learn more in API Response Codes.

pageIdentifierstring or null
Auxiliary validation used internally by payment pages and components.
roomIdlong or null

Describes the room ID. Only in use on Boarding endpoints, returns 0 when not applicable.

isSuccessboolean or null

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

responseDatastring or integer or null
The response data.

Errors