API referencePay 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.
additionalFieldsmap from strings to optional stringsOptional

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

addressstringOptional
Customer address
address1stringOptional
Additional customer address
balancedoubleOptional
Customer balance.
citystringOptional
Customer city
companystringOptional
Company name
countrystringOptional

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

createdAtdatetimeOptional
Timestamp of when record was created, in UTC.
customerNumberstringOptional<=250 characters

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

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)
customerUsernamestringOptional
Customer username for customer portal
emailstringOptionalformat: "email"<=320 characters
Customer email address.
firstnamestringOptional
Customer first name
identifierFieldslist of optional stringsOptional
List of fields acting as customer identifiers, to be used instead of CustomerNumber.
lastnamestringOptional
Customer last name
phonestringOptional
Customer phone number
shippingAddressstringOptional<=250 characters
The shipping address.
shippingAddress1stringOptional<=100 characters
Additional line for shipping address.
shippingCitystringOptional<=250 characters
Shipping city.
shippingCountrystringOptional
Shipping address country.
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”.

statestringOptional
Customer State
timeZoneintegerOptional

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

zipstringOptional
Customer zip code

Response

Success
isSuccessboolean

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

pageIdentifierstring
Auxiliary validation used internally by payment pages and components.
responseCodeinteger

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

responseDatastring or integer
The response data.
responseTextstring

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

Errors

400
Bad Request Error
401
Unauthorized Error
500
Internal Server Error
503
Service Unavailable Error