Update a customer

put

https://test-api.payology.io/customer-vault/api/v1/customer/{token}

Update supplied fields. Deactivating a customer can also deactivate associated profiles and schedules; returned token arrays identify those side effects.

Request examples

ContactDetails

PUT /customer-vault/api/v1/customer/22222222-2222-4222-8222-222222222222 HTTP/1.1
Authorization: <PAYOLOGY_API_KEY>
Accept: application/json
Content-Type: application/json

Deactivate

PUT /customer-vault/api/v1/customer/22222222-2222-4222-8222-222222222222 HTTP/1.1
Authorization: <PAYOLOGY_API_KEY>
Accept: application/json
Content-Type: application/json

Result codes in the response examples

HTTP status and result code are operation-specific. Field-validation messages can include the affected field name.

HTTP	Code	Result	Meaning
200	R0000	Ok	The request was processed successfully
400	R0002	Error	Field is not properly formatted
400	R0221	Error	Customers organization is inactive
401	R0003	Error	Authentication token is invalid
403	R0003	Error	Access not allowed
404	R0142	Error	Customer token is invalid
500	R0999	Error	Something went wrong

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Path Params

token

string

required

[0-9A-Fa-f]{8}-[0-9A-Fa-f]{4}-4[0-9A-Fa-f]{3}-[89ABab][0-9A-Fa-f]{3}-[0-9A-Fa-f]{12}

Customer UUID to retrieve/update, or filter in the customer list.

Body Params

JSON request body. Required and conditional fields are defined by the schema. Named examples show supported request variants.

Send at least one recognized field. When changing names, provide a valid first_name/last_name pair or company_name. Empty string can clear supported contact/name fields; phone and postal_code also accept null. Deactivating the customer may deactivate its related profiles and schedules.

first_name

string

length ≤ 50

Customer or cardholder given name.

last_name

string

length ≤ 50

Customer or cardholder family name.

company_name

string

length ≤ 100

Customer company name; can supply the company identity instead of an individual name pair.

address

string

length ≤ 100

Street address, first line.

address_2

string

length ≤ 25

Street address, second line, such as suite or apartment.

country

string

length ≤ 2

Two-letter country code, such as US or CA.

city

string

length ≤ 20

Address city.

province

string

length ≤ 50

State/province code. US and CA values are checked against their country-specific state/province lists when country is supplied.

postal_code

string | null

Postal code. Creation validates its format against the supplied country; include country when providing postal_code. US examples: 10001 or 10001-1234; CA example: K1A 0B1. The update validator currently accepts US ZIP format, an empty string or null.

phone

string | null

Contact phone. A nonempty value must match the supported phone-number format and have 7–20 characters; null clears the value on update.

string

Customer email address.

identification_number

string

length ≤ 15

Optional customer identification value; customer read responses mask sensitive values.

default_payment_profile_token

string | null

UUID of the customer default payment profile; null represents no default.

user_defined_1

string

length ≤ 100

Optional first customer-defined text value.

user_defined_2

string

length ≤ 100

Optional second customer-defined text value.

user_defined_3

string

length ≤ 100

Optional third customer-defined text value.

reference_id

string

length ≤ 100

Partner-assigned reference used for reconciliation and supported reference lookups. Resource creation can enforce uniqueness within its scope.

active

boolean

Whether the resource is active and available for its supported operations.

customer_type

string

enum

Customer classification: Billing, Shipping or Other.

Allowed:

Responses

default

Other infrastructure or forwarded downstream response. HTTP status and body must be preserved; do not assume every error has a Payology R-code. No fixed payload is guaranteed.

200Customer updated.

400Invalid fields, selector, or business rule. Consult the individual example code.

401Authentication failed. Some services also use 401 for organization access denial. Gateway bodies can differ.

403Permission or organization access denied; the gateway can reject the request before it reaches the service.

404Requested resource or lookup reference was not found.

413Possible gateway request size rejection. Service-specific limits and response templates require environment verification.

429Gateway throttling or quota. Exact quota, retry headers and deployed body were not verified. This is a platform possibility, not an observed Payology response.

500Unhandled service failure. Gateway configuration/authorizer failures can also return 500.

504Gateway integration timeout or failure. The service may still have committed a create request. This is a platform possibility, not an observed Payology response.