REresolvepay
Customers

Enroll a customer

Records a Net Terms Agreement acceptance captured by you and enrolls an approved customer. Both happen in one transaction — if enrollment fails, the acceptance is not recorded.

The signed agreement PDF is generated asynchronously, so it is not available in the response. It records the signer details and IP address supplied here.

post/customers/{customer_id}/net-terms-acceptance

Request

Path parameters

customer_idstring required

ID of the customer to enroll

Request body

agreement_type'net_terms_agreement'

The agreement the signer accepted. net_terms_agreement is the only accepted value.

signer_namestring required

Full name of the person who accepted the agreement.

signer_emailstring email required

Email address of the person who accepted the agreement.

signer_titlestring nullable

Job title of the person who accepted the agreement.

authorization_attestationtrue required

Confirms the signer is authorized to accept the agreement on behalf of the customer. Must be true — any other value is rejected with 400.

notify_buyerboolean

When true, Resolve emails the customer to confirm enrollment.

platform_user_idstring

Your own identifier for the user who accepted, stored alongside the acceptance record.

platform_session_idstring

Your own identifier for the session the acceptance was captured in, stored alongside the acceptance record.

Example request

{
  "agreement_type": "net_terms_agreement",
  "signer_name": "Dana Whitfield",
  "signer_email": "dana.whitfield@buyer-example.com",
  "signer_title": "Controller",
  "authorization_attestation": true,
  "external_userinfo": {
    "ip": "203.0.113.42",
    "user_agent": "Mozilla/5.0 (Macintosh; Intel Mac OS X 10_15_7) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/128.0.0.0 Safari/537.36"
  },
  "platform_user_id": "plat_user_8842",
  "platform_session_id": "plat_sess_c31f9a"
}

Response

An object representing the enrolled customer, with net_terms_status set to enrolled.

The response carries no acceptance identifier.

idstring
merchant_idstring

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

external_idstring nullable

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

created_atstring date-time

Date the customer was created.

updated_atstring date-time

Date the customer was last updated.

source'QUICKBOOKS' | 'MERCHANT_USER' | 'ADMIN_USER' | 'APPLICATION' | 'CUSTOMER_USER' | 'API'
business_addressstring

Street address of the business' primary location.

business_citystring

City of the business' primary location.

business_statestring

State or province of the business' primary location.

business_zipstring

US zip code of the business' primary location.

business_countrystring

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

business_age_range'0-2' | '2-5' | '5-10' | '10+'

String indicating age of the business in years.

business_ap_emailstring

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

business_ap_phonestring

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

business_ap_phone_extensionstring

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

business_namestring

Full legal name of the business being applied for.

business_trade_namestring

Trade name of the business, if different than business_name.

business_phonestring

Phone number of the business' primary location.

business_type'sole_prop_or_partnership' | 'llc' | 'corporation' | 'nonprofit' | 'government'

String indicating the business' type of legal entity.

emailstring email

Email of the customer applying for terms.

personal_name_firststring

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

personal_name_laststring

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

personal_phonestring

Personal phone number of the customer representative applying for terms.

amount_approvedinteger

Total amount of the credit approved.

amount_authorizedinteger

Amount of the credit line reserved for authorized charges.

amount_availableinteger

Current amount of the credit line available for purchases.

amount_balanceinteger

Current balance on the customer's credit line.

amount_unapplied_paymentsinteger

Current amount of a customer's unapplied payments.

default_terms'net7' | 'net10' | 'net10th' | 'net15' | 'net20' | 'net30' | 'net45' | 'net60' | 'net75' | 'net90' | 'net120' | 'net180' | 'null' nullable

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

advance_ratenumber double nullable

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

credit_status'approved' | 'hold' | 'declined' | 'pending' | 'deactivated' | 'null' nullable

Current credit status of this customer. See <a href="#operation/requestCustomerCreditCheck">#request-a-credit-check</a> for more details.

net_terms_status'enrolled' | 'pending_enrollment' | 'enrollment_expired' | 'null' nullable

Current net terms enrollment status of this customer. See <a href="#operation/fetchCustomer">#fetchCustomer</a> for more details.

net_terms_enrollment_urlstring nullable

The URL for a customer to complete enrollment requirements when net_terms_status is pending_enrollment. See <a href="#operation/fetchCustomer">#fetchCustomer</a> for more details.

net_terms_enrollment_expires_atstring date-time nullable

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

credit_check_requested_atstring date-time nullable

The date a credit check was requested.

archivedboolean

Boolean indicating if customer is archived.

duns_numberstring nullable

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

Example 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,
  "advance_rate": 0.75,
  "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",
  "duns_number": "00-123-4567",
  "credit_decisions": [
    {
      "id": "abc123",
      "created_at": "2020-01-01T00:00:00.750Z",
      "decision": "approved",
      "amount": 10000,
      "advance_rate": 0.75,
      "decline_code": "no_business_found",
      "hold_code": "past_due"
    }
  ]
}

Changes

No recorded changes to this operation across all 1 revision of this API.