Create customer

post

https://sandbox.api.mxmerchant.com/checkout/v3/customer

Create a new customer

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Query Params

echo

boolean

Defaults to true

Return results

Body Params

merchantId

int32

required

Merchant id

name

string

required

Customer's full name (display name)

firstName

string

required

Customer's first name

lastName

string

Customer's last name

address1

string

Street address

address2

string

Apartment, suite, department

city

string

City

state

string

State

zip

string

Zip code

addressName

string

Name for address, i.e. home, work

customerType

string

Defaults to Person

Type of customer: Business or Person

string

Customer's email address

mobile

string

Customer's cell phone number

phone

string

Customer's phone number

number

string

Client provided customer number

isTaxExempt

boolean

Defaults to false

Is this customer tax exempt?

taxId

string

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

spendProfile

string

Customer's spend profile

customFields

array of objects

Client-defined custom fields. Must be set up prior to use

customFields

activeStatus

boolean

Defaults to true

Is the customer active?

selectedSpendProfile

string

Spend profile selected for customer

spendProfileOverride

boolean

Defaults to false

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

Responses

Language

Credentials

Basic

base64

Loading…

Response

Click Try It! to start a request and see the response here! Or choose an example:

application/json

201201

400400