API Support: accounts@resolvepay.com
Legacy (v2) API documentation: https://app.resolvepay.com/docs/api/v2
The Resolve API is organized around REST principles. It uses predictable resource-oriented URLs, standard HTTP verbs and response codes, and accepts and returns JSON-encoded request and response bodies.
Resolve offers both server-side and client-side integrations. This documentation refers to the server-side API. Refer to our e-commerce plugin guides for details on client-side checkout solutions.
There is a sandbox API available for testing, which leverages the same data store as your sandbox dashboard. Testing on sandbox won't affect your live data or create money movements.
| Environment | Base URL |
| Production | https://app.resolvepay.com/api/ |
| Sandbox | https://app-sandbox.resolvepay.com/api/ |
Before using the API, reach out and get your Resolve account created. This account enables access to the credentials that are necessary for API access.
Resolve uses HTTP basic authentication where the username refers to your merchant ID, and the password refers to your secret API key.
When backwards-incompatible changes are released, a new, dated version is released. The current version is V5. You can upgrade the version of the api that your account uses within your merchant settings.
Legacy (v2) API documentation may be found here.
All top-level API resources have support for bulk fetches via "list" API methods. For instance, you can list customers, list invoices.
These list API methods share a common structure, taking at least two parameters: limit and page.
count - represents total amount of records, satisfying the request query.page - a multiplier value, which gets applied to the limit and shows what position records are being returned from. For example, if limit = 20 and page = 5, then maximun 20 records will be returned from position 5 * 20 = 100.limit - maximun amount of records, which can be returned.results - array of records being returned. If no records satisfy request condition, the array will be empty.To ensure platform reliability and fair use, Resolve implements rate limits for the REST API.
Resolve APIs use the Sliding Window algorithm to monitor and control request rates with a 100 requests/minute limit. The API will return a 429 Too Many Requests status if the amount of requests exceeds rate limits.
All responses from Resolve APIs will include the following headers:
X-Ratelimit-Limit: The maximum amount of requests permitted within a 60-second period.X-Ratelimit-Remaining: The remaining requests within the current period.X-Ratelimit-Reset: A UNIX timestamp indicating when the rate limit period will reset.X-Ratelimit-Limit and X-Ratelimit-Remaining response headers in your application to avoid surpassing rate limits.429 status code.The invoice represents the business transaction between you and your customer. In Resolve, an invoice must be tied to a customer and an advance can be taken on the invoice.
For an advance to be taken on the invoice, a PDF of the invoice must be uploaded and the associated customer must be approved and have available credit for the amount of the invoice.
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.
Payout Transactions are the individual transactions like customer payments, Resolve advances, forwarded payments, etc. that are rolled into a Payout. Each Payout is the sum of one or more transactions. Note that certain fields are only relevant to certain transaction types - e.g.: a Payout Transaction of type monthly_fee will have both customer_id and invoice_id set to null.
Filter Payout Transactions 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:
customer_id (eq, ne)created_at (eq, gt, lt, gte, lte)payout_id (eq, ne)invoice_id (eq, ne)Example: filter[created_at][gte]=2021-01-01T00:00:00.000Z
Note: filter with the eq operator is equivalent to the following filter filter[field]=value
Sort Payout Transactions 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.
Example: sort=id,-created_at
curl -i -X GET \
-u <username>:<password> \
'https://api-docs.resolvepay.com/_mock/swagger/payout-transactions?limit=25&page=1&filter=string&sort=string'{ "limit": 25, "page": 1, "results": [ { … } ] }
curl -i -X GET \
-u <username>:<password> \
'https://api-docs.resolvepay.com/_mock/swagger/payout_transactions/{payout_transaction_id}'An object representing the created Payout Transaction.
Type of the payout transaction.
Date time of when the payout transaction was created.
{ "id": "AOncfxMnm", "payout_id": "gQxGLAowY", "type": "advance", "customer_id": "voArW2nSs", "customer_name": "Test name", "invoice_id": "C2vBqxfZ4", "invoice_number": "R334-097R", "order_id": "u5WRraCYY", "po_number": "PO-09785", "amount_gross": 100, "amount_fee": 3, "amount_net": 97, "created_at": "2022-09-06T03:08:37.508Z", "updated_at": "2022-09-06T03:08:37.508Z" }
A payment represents a transaction where a customer pays towards their invoices. When a payment is made to Resolve, the customer's available credit balance is increased by the amount of the payment. Payments can be made via various methods including ACH, credit card, check, or wire transfer. Each payment can be applied to one or more invoices.
A shipment represents the fulfillment of goods or services for an invoice. Track shipments to monitor delivery status and fulfillment progress. Shipments can be fulfilled through various methods including shipping providers, self-delivery, customer pickup, or for services-only transactions.