Create a new customer

Create a new customer.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Query Params
boolean
Defaults to true

If true, the API will echo the full payment resource in the response body

Body Params

The Customer information.

Customer model

string

Customer's full name (display name)

string

Customer's first name

string

Customer's last name

string

Client provided customer number

string
length ≤ 9

Customer's SSN or EIN (9 digits) (Required for tax exempt customers)

string

Customer's email address

string

Customer's cellphone number

string

Customer's home phone number (if any)

string

Customer's spend profile

customFields
array of objects

Array of custom fields

customFields
string

(headquarters, administrative)

string

Street address

string

Apartment, suite, department

string

City

string

State

string
^\d{5}(?:[-]\d{4})?$|^\d{9}$|(^[ABCEGHJKLMNPRSTVXYabceghjklmnprstvxy]{1}\d{1}[A-Za-z]{1} *\d{1}[A-Za-z]{1}\d{1}$)

Zip

string
enum

customer type

Allowed:
boolean

If the spend profile was selected or sent manually, this would be true.

boolean

Indicates whether the customer is exempt from paying the tax

int32

Merchant ID

boolean

Indicates whether the customer is active or inactive

Headers
string
enum
Defaults to application/json

Generated from available request content types

Allowed:
Responses

Language
Credentials
Header
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json