Need help with your APIs? I offer API discovery, governance & evangelism services. Explore services →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Resolve Customers API

A customer represents a company that you do business with. For larger companies, there may be several users with access to the customer account that can make purchases with their credit line. For smaller companies, a customer may represent a single individual. Retrieve a customer to get a summary of their total credit line and available credit balance.

Resolve Customers API is one of 12 APIs that Resolve publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include Customers. The published artifact set on APIs.io includes an OpenAPI specification.

This API exposes 6 operations across 4 paths, and defines 11 schemas. It is described by OpenAPI 3.0.0, at version V5.

Requests are made against a single base URL, https://app-sandbox.resolvepay.com/api.

6 operations 4 paths 11 schemas 2 GET3 POST1 PUT

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.0.0
API Version
V5
Base URL
https://app.resolvepay.com/api
Authentication
HTTP Basic, HTTP Bearer
Resource Areas
1

Authentication & Security 2

Resolve Customers API declares 2 security schemes for authenticating requests. It accepts HTTP basic authentication (basicAuth). It accepts HTTP bearer tokens (JWT) (bearerAuth). By default, every request must be authenticated.

  • basicAuth — HTTP Basic Auth using merchantid as username and the merchant secret key as password.
  • bearerAuth — Bearer token authentication using an OAuth access token minted for an API access key created in Merchant Dashboard.

Paths & Operations 6

Across 4 paths, the API surfaces 6 operations — 2 GET, 3 POST, 1 PUT. Each is listed below with its method, path, parameters, and response codes.

Customers 6

A customer represents a company that you do business with. For larger companies, there may be several users with access to the customer account that can make purchases with their…

GET
/customers
List all customers
listCustomers 4 params → 200400401429
POST
/customers
Create a customer
createCustomer body → 200400401404429
GET
/customers/{customer_id}
Fetch a customer
fetchCustomer 1 param → 200401404429
PUT
/customers/{customer_id}
Update a customer
updateCustomer 1 param body → 200400401404429
POST
/customers/{customer_id}/enrolldeprecated
Enroll a customer
enroll-a-customer 1 param → 200400401404422429
POST
/customers/{customer_id}/credit-check
Request a credit check
requestCustomerCreditCheck 1 param body → 204400401404422429

Schemas 11

The contract defines 11 schemas that model the data the API accepts and returns. The most detailed are Customer (36 properties), CustomerPutRequest (11 properties), CustomerPostRequest (11 properties), CustomerCreditCheckRequest (4 properties). Each schema is shown below with its type and property counts.

Customer
object
The customer object represents a company that you do business with. Retrieve a customer to get a summary of their total credit line and available credit balanc…
36 properties
CustomerPostRequest
object
11 properties 8 required
CustomerPutRequest
object
11 properties
UnauthorizedError
object
1 property
CustomerList
object
4 properties
NotFoundError
object
1 property
CreditCheckExistsError
object
1 property
ValidationError
object
1 property
InvalidRequestError
object
1 property
CustomerCreditCheckRequest
object
4 properties 2 required
RateLimitError
object
1 property

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

resolve-customers-api-openapi.yml Raw ↑

Other APIs Resolve publishes across the network.

Resolve Access Keys API
Resolve Charges API
Resolve Credit Notes API
Resolve Invoices API
Resolve Merchants API
Resolve Orders API
Resolve Payments API
Resolve Payout Transactions API
Resolve Payouts API
Resolve Shipments API
Resolve Webhooks API