REresolvepay
Customers

List all customers

Return a list of customers. For single-merchant partners, this returns customers belonging to your sub-merchants. For marketplace partners, this returns customers belonging to your marketplace.

get/customers

Request

Query parameters

limitinteger

Limit the number of customers returned.

pagestring

Specify the page of customers returned.

Filter customers by the specified fields.

Filter semantics: filter[field][operator]=value.

Available filter operators:

  • eq - equal (=)
  • ne - not equal (!=)
  • gt - greater than (>)
  • gte - greater than or equal (>=)
  • lt - less than (<)
  • lte - less than or equal (<=)

Filtering is allowed by the following fields:

  • merchant_id (eq) — only available for single-merchant partners
  • external_id (eq)
  • email (eq)
  • business_name (eq)
  • created_at (eq, gt, lt, gte, lte)
  • amount_approved (eq, gt, lt, gte, lte)
  • amount_available (eq, gt, lt, gte, lte)
  • amount_authorized (eq, gt, lt, gte, lte)
  • amount_balance (eq, gt, lt, gte, lte)
  • amount_unapplied_payments (eq, gt, lt, gte, lte)
  • advance_rate (eq, gt, lt, gte, lte)
  • archived (eq, ne)

Example: filter[email][eq]=test@resolvepay.com Example: filter[external_id][eq]=CUS-123456

Note: filter with the eq operator is equivalent to the following filter filter[field]=value

sortstring

Sort customers by the specified fields.

The sort order for each sort field is ascending unless it is prefixed with a minus, in which case it is descending.

Multiple sort fields supported by allowing comma-separated sort fields. Sort fields will be applied in the order specified.

Sorting is allowed by the following fields: id, created_at, amount_approved, amount_available, business_name.

Example: sort=business_name,-created_at

Response

An object with an array of results containing up to the limit. If no customers are found, the results array will be empty.

countinteger
limitinteger
pageinteger

Example response

{
  "count": 1,
  "limit": 25,
  "page": 1,
  "results": [
    {
      "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.