Create a customer

Partners API/

Create a customer

Request

Create a customer. Supporting documents are submitted after creation using Upload a customer supporting document.

Security

bearerAuth or basicAuth

Bodyapplication/json

Customer to add to the system.

merchant_idstring

ID of the sub-merchant this customer belongs to. Required for single-merchant partners. Must be a valid sub-merchant under your partner account. Not accepted for marketplace partners — customers belong to the marketplace itself.

Example:"MER456789"

external_idstring or null

Optional customer identifier from your system. This value is not required to be unique.

Example:"CUS-123456"

business_addressstringrequired

Street address of the business' primary location.

Example:"111 Main Street"

business_citystringrequired

City of the business' primary location.

Example:"San Francisco"

business_statestringrequired

State or province of the business' primary location.

Example:"CA"

business_zipstringrequired

US zip code of the business' primary location.

Example:"94104"

business_countrystring, (ISO 3166-1 alpha 2)required

2-letter country code of the business' primary location, according to the ISO 3166-1 alpha 2 standard.

Example:"US"

business_ap_emailstring, (email)required

Email address of the business' accounts payable person or department.

Example:"ap@example.com"

business_ap_phonestring

Phone number of the business' accounts payable person or department.

Example:"(202) 456-1414"

business_ap_phone_extensionstring

Phone number extension of the business' accounts payable person or department.

Example:"123"

business_namestringrequired

Full legal name of the business being applied for.

Example:"Example, Inc."

emailstring, (email)required

Email of the customer applying for terms.

Example:"user@example.com"

default_termsstring or null

Default terms invoices will be advanced with.

Enum:"net7""net10""net10th""net15""net20""net30""net45""net60""net75""net90"

curl -i -X POST \
  https://docs.resolvepay.com/_mock/partners-api/openapi/customers \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "merchant_id": "MER456789",
    "external_id": "CUS-123456",
    "business_address": "111 Main Street",
    "business_city": "San Francisco",
    "business_state": "CA",
    "business_zip": "94104",
    "business_country": "US",
    "business_ap_email": "ap@example.com",
    "business_ap_phone": "(202) 456-1414",
    "business_ap_phone_extension": "123",
    "business_name": "Example, Inc.",
    "email": "user@example.com",
    "default_terms": "net7"
  }'

Responses

An object representing the customer.

Bodyapplication/json

idstring

Example:"PMMlaE5wbg0"

merchant_idstring

ID of the sub-merchant this customer belongs to. Only present for single-merchant partners.

Example:"MER456789"

external_idstring or null

Optional customer identifier from your system. This value is not required to be unique and can be used with the external_id list filter.

Example:"CUS-123456"

created_atstring, (date-time)

Date the customer was created.

Example:"2020-01-01T00:00:00.750Z"

updated_atstring, (date-time)

Date the customer was last updated.

Example:"2020-01-01T00:00:00.750Z"

sourcestring

Enum:"QUICKBOOKS""MERCHANT_USER""ADMIN_USER""APPLICATION""CUSTOMER_USER""API"

Example:"MERCHANT_USER"

business_addressstring

Street address of the business' primary location.

Example:"111 Main Street"

business_citystring

City of the business' primary location.

Example:"San Francisco"

business_statestring

State or province of the business' primary location.

Example:"CA"

business_zipstring

US zip code of the business' primary location.

Example:"94104"

business_countrystring

Country of the business' primary location according to the ISO 3166-1 alpha 2 standard.

Example:"US"

business_age_rangestring

String indicating age of the business in years.

Enum:"0-2""2-5""5-10""10+"

Example:"5-10"

business_ap_emailstring

Email address of the business' accounts payable person or department.

Example:"ap@example.com"

business_ap_phonestring

Phone number of the business' accounts payable person or department.

Example:"(202) 456-1414"

business_ap_phone_extensionstring

Phone number extension of the business' accounts payable person or department.

Example:"123"

business_namestring

Full legal name of the business being applied for.

Example:"Example, Inc."

business_trade_namestring

Trade name of the business, if different than business_name.

Example:"Example Trading Company"

business_phonestring

Phone number of the business' primary location.

Example:"(202) 456-1414"

business_typestring

String indicating the business' type of legal entity.

Enum:"sole_prop_or_partnership""llc""corporation""nonprofit""government"

Example:"corporation"

emailstring, (email)

Email of the customer applying for terms.

Example:"user@example.com"

personal_name_firststring

First name of the person applying on behalf of the business.

Example:"James"

personal_name_laststring

Last name of the person applying on behalf of the business.

Example:"Bond"

personal_phonestring

Personal phone number of the customer representative applying for terms.

Example:"(202) 456-1414"

amount_approvedinteger, (int64)

Total amount of the credit approved.

Example:10000

amount_authorizedinteger, (int64)

Amount of the credit line reserved for authorized charges.

Example:10000

amount_availableinteger, (int64)

Current amount of the credit line available for purchases.

Example:10000

amount_balanceinteger, (int64)

Current balance on the customer's credit line.

Example:2000

amount_unapplied_paymentsinteger, (int64)

Current amount of a customer's unapplied payments.

Example:1000

default_termsstring or null

Set default terms that will apply to this customer's invoices. Can be overridden when requesting an advance.

Enum:"net7""net10""net10th""net15""net20""net30""net45""net60""net75""net90"

advance_ratenumber or null, (double), [ 0 .. 1 ]

The advance rate that will be used to determine the amount advanced for this customer's invoices.

Example:0.75

credit_statusstring or null

Current credit status of this customer. See #request-a-credit-check for more details.

Enum:"approved""hold""declined""pending""deactivated"null

net_terms_statusstring or null

Current net terms enrollment status of this customer. See #fetchCustomer for more details.

Enum:"enrolled""pending_enrollment""enrollment_expired"null

net_terms_enrollment_urlstring or null

The URL for a customer to complete enrollment requirements when net_terms_status is pending_enrollment. See #fetchCustomer for more details.

Example:"www.app.resolvepay.com/merchant-id/activate/123456"

net_terms_enrollment_expires_atstring or null, (date-time)

The date by which the customer must be enrolled in this net terms offer, not null when net_terms_status is pending_enrollment.

Example:"2020-01-01T00:00:00.750Z"

credit_check_requested_atstring or null, (date-time)

The date a credit check was requested.

Example:"2020-01-01T00:00:00.750Z"

archivedboolean

Boolean indicating if customer is archived.

Example:false

duns_numberstring or null

Dun & Bradstreet unique nine-digit identifier for businesses that is associated with a business's Live Business Identity

Example:"00-123-4567"

credit_decisionsArray of objects

Array of credit decisions made for this customer.

Response

{
  "id": "PMMlaE5wbg0",
  "merchant_id": "MER456789",
  "external_id": "CUS-123456",
  "created_at": "2020-01-01T00:00:00.750Z",
  "updated_at": "2020-01-01T00:00:00.750Z",
  "source": "MERCHANT_USER",
  "business_address": "111 Main Street",
  "business_city": "San Francisco",
  "business_state": "CA",
  "business_zip": "94104",
  "business_country": "US",
  "business_age_range": "5-10",
  "business_ap_email": "ap@example.com",
  "business_ap_phone": "(202) 456-1414",
  "business_ap_phone_extension": "123",
  "business_name": "Example, Inc.",
  "business_trade_name": "Example Trading Company",
  "business_phone": "(202) 456-1414",
  "business_type": "corporation",
  "email": "user@example.com",
  "personal_name_first": "James",
  "personal_name_last": "Bond",
  "personal_phone": "(202) 456-1414",
  "amount_approved": 10000,
  "amount_authorized": 10000,
  "amount_available": 10000,
  "amount_balance": 2000,
  "amount_unapplied_payments": 1000,
  "default_terms": "net7",
  "advance_rate": 0.75,
  "credit_status": "approved",
  "net_terms_status": "enrolled",
  "net_terms_enrollment_url": "www.app.resolvepay.com/merchant-id/activate/123456",
  "net_terms_enrollment_expires_at": "2020-01-01T00:00:00.750Z",
  "credit_check_requested_at": "2020-01-01T00:00:00.750Z",
  "archived": false,
  "duns_number": "00-123-4567",
  "credit_decisions": [
    { … }
  ]
}