Create a customer

post

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

Create a customer and retain customer_token. Provide organization_token and customer_type, plus a company_name or a complete first_name/last_name pair. The first and last name must be supplied together even if a company name is present. Successful creation returns HTTP 201.

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
201	R0000	Ok	The request was processed successfully
400	R0002	Error	Field is not properly formatted
400	R0201	Error	Organization token is invalid
400	R0202	Error	Organization is inactive
401	R0003	Error	Authentication token is invalid
403	R0003	Error	Access not allowed
500	R0999	Error	Something went wrong

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

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.

201Customer created.

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.

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.