Table of Contents
Acquire is the first to bring a multi-channel customer communication platform for businesses, empowering companies to deliver better experiences between customers and their sales and support teams.
API Overview
Acquire is a modern, cloud-based payment gateway that provides businesses with a comprehensive suite of features to accept and manage payments securely and efficiently. It offers a user-friendly dashboard, customizable payment forms, fraud prevention tools, and reporting capabilities. Acquire seamlessly integrates with various e-commerce platforms and payment processors, allowing businesses to streamline their payment operations and enhance their customer experience.
Acquire's API provides a robust set of RESTful APIs that enable developers to integrate payment functionality into their applications. The API documentation is extensive and well-organized, providing clear instructions and code examples for various use cases. The APIs cover a wide range of operations, including creating and managing payment forms, processing transactions, handling refunds, and managing subscriptions. Acquire also offers webhooks that allow businesses to receive real-time notifications for events such as successful payments or chargebacks. To ensure the stability and performance of its platform, Acquire implements rate limits to prevent excessive API calls and maintain a consistent user experience.
API Request Limits
Free
10,000 requests per day
Pro
100,000 requests per day
Business
1,000,000 requests per day
SDKs
APIs
Method: GET
Description: Return a list of alert rules..
Endpoint: /alerts
Parameters: /filter
Method: GET
Description: Return a specific alert rule..
Endpoint: /alerts/{ruleid}
Parameters: /filter
Method: PUT
Description: Update an alert rule..
Endpoint: /alerts/{ruleid}
Parameters: /filter
Method: POST
Description: Create an alert rule..
Endpoint: /alerts
Parameters: /filter
Method: PATCH
Description: Partially update an alert rule..
Endpoint: /alerts/{ruleid}
Parameters: /filter
Method: DELETE
Description: Delete an alert rule..
Endpoint: /alerts/{ruleid}
Parameters: /filter
Method: GET
Description: Return a list of anomaly detection reports..
Endpoint: /anomalies
Parameters: /filter
Method: GET
Description: Return a specific anomaly report..
Endpoint: /anomalies/{id}
Parameters: /filter
Method: POST
Description: Create an anomaly report..
Endpoint: /anomalies
Parameters: /filter
Method: DELETE
Description: Delete an anomaly report..
Endpoint: /anomalies/{id}
Parameters: /filter
Method: GET
Description: Return a list of applications..
Endpoint: /apps
Parameters: /filter
Method: GET
Description: Return a specific application..
Endpoint: /apps/{id}
Parameters: /filter
Method: POST
Description: Create an application..
Endpoint: /apps
Parameters: /create
Method: PUT
Description: Update an application..
Endpoint: /apps/{id}
Parameters: /update
Method: PATCH
Description: Partially update an application..
Endpoint: /apps/{id}
Parameters: /update
Method: DELETE
Description: Delete an application..
Endpoint: /apps/{id}
Parameters: /delete
Method: GET
Description: Return a list of application resources..
Endpoint: /resources
Parameters: /filter
Method: GET
Description: Return a specific application resource..
Endpoint: /resources/{id}
Parameters: /filter
Method: POST
Description: Create an application resource..
Endpoint: /resources
Parameters: /filter
Method: PUT
Description: Update an application resource..
Endpoint: /resources/{id}
Parameters: /filter
Method: PATCH
Description: Partially update an application resource..
Endpoint: /resources/{id}
Parameters: /filter
Method: DELETE
Description: Delete an application resource..
Endpoint: /resources/{id}
Parameters: /filter
Method: GET
Description: Return a list of asset relationships..
Endpoint: /relationships
Parameters: /filter
Method: GET
Description: Return a specific asset relationship..
Endpoint: /relationships/{id}
Parameters: /filter
Method: POST
Description: Create an asset relationship..
Endpoint: /relationships
Parameters: /create
Method: PUT
Description: Update an asset relationship..
Endpoint: /relationships/{id}
Parameters: /update
Method: PATCH
Description: Partially update an asset relationship..
Endpoint: /relationships/{id}
Parameters: /update
Method: DELETE
Description: Delete an asset relationship..
Endpoint: /relationships/{id}
Parameters: /delete
Method: GET
Description: Return a list of asset items..
Endpoint: /assets
Parameters: /filter
Method: GET
Description: Return a specific asset item..
Endpoint: /assets/{id}
Parameters: /filter
Method: POST
Description: Create an asset item..
Endpoint: /assets
Parameters: /create
Method: PUT
Description: Update an asset item..
Endpoint: /assets/{id}
Parameters: /update
Method: PATCH
Description: Partially update an asset item..
Endpoint: /assets/{id}
Parameters: /update
Method: DELETE
Description: Delete an asset item..
Endpoint: /assets/{id}
Parameters: /delete
Method: GET
Description: Return a list of booms..
Endpoint: /booms
Parameters: /filter
Method: GET
Description: Return a specific boom..
Endpoint: /booms/{boomid}
Parameters: /filter
Method: POST
Description: Create a boom..
Endpoint: /booms
Parameters: /filter
Method: PUT
Description: Update a boom..
Endpoint: /booms/{boomid}
Parameters: /filter
Method: PATCH
Description: Partially update a boom..
Endpoint: /booms/{boomid}
Parameters: /filter
Method: DELETE
Description: Delete a boom..
Endpoint: /booms/{boomid}
Parameters: /filter
Method: GET
Description: Return a list of computations..
Endpoint: /computations
Parameters: /filter
Method: GET
Description: Return a specific computation..
Endpoint: /computations/{id}
Parameters: /filter
Method: POST
Description: Create a computation..
Endpoint: /computations
Parameters: /filter
Method: PUT
Description: Update a computation..
Endpoint: /computations/{id}
Parameters: /filter
Method: PATCH
Description: Partially update a computation..
Endpoint: /computations/{id}
Parameters: /filter
Method: DELETE
Description: Delete a computation..
Endpoint: /computations/{id}
Parameters: /filter
Method: GET
Description: Return a list of contribution factors..
Endpoint: /factors
Parameters: /filter
Method: GET
Description: Return a specific contribution factor..
Endpoint: /factors/{factorid}
Parameters: /filter
Method: POST
Description: Create a contribution factor..
Endpoint: /factors
Parameters: /create
Method: PUT
Description: Update a contribution factor..
Endpoint: /factors/{factorid}
Parameters: /update
Method: PATCH
Description: Partially update a contribution factor..
Endpoint: /factors/{factorid}
Parameters: /update
Method: DELETE
Description: Delete a contribution factor..
Endpoint: /factors/{factorid}
Parameters: /delete
Method: GET
Description: Return a list of dashboard..
Endpoint: /dashboards
Parameters: /filter
Method: GET
Description: Return a specific dashboard..
Endpoint: /dashboards/{dashboardid}
Parameters: /filter
Method: POST
Description: Creates a new dashboard..
Endpoint: /dashboards
Parameters: /filter
Method: PUT
Description: Update a dashboard..
Endpoint: /dashboards/{dashboardid}
Parameters: /filter
Method: PATCH
Description: Partially update a dashboard..
Endpoint: /dashboards/{dashboardid}
Parameters: /filter
Method: DELETE
Description: Delete a dashboard..
Endpoint: /dashboards/{dashboardid}
Parameters: /filter
Method: GET
Description: Return a list of dashboard shares..
Endpoint: /shares
Parameters: /filter
Method: GET
Description: Return a specific dashboard share..
Endpoint: /shares/{shareid}
Parameters: /filter
Method: POST
Description: Create a dashboard share..
Endpoint: /shares
Parameters: /filter
Method: PUT
Description: Update a dashboard share..
Endpoint: /shares/{shareid}
Parameters: /filter
Method: PATCH
Description: Partially update a dashboard share..
Endpoint: /shares/{shareid}
Parameters: /filter
Method: DELETE
Description: Delete a dashboard share..
Endpoint: /shares/{shareid}
Parameters: /filter
Method: GET
Description: Return a list of data connections..
Endpoint: /connections
Parameters: /filter
Method: GET
Description: Return a specific data connection..
Endpoint: /connections/{id}
Parameters: /filter
Method: POST
Description: Create a data connection..
Endpoint: /connections
Parameters: /create
Method: PUT
Description: Update a data connection..
Endpoint: /connections/{connectionid}
Parameters: /update
Method: PATCH
Description: Partially update a data connection..
Endpoint: /connections/{connectionid}
Parameters: /update
Method: DELETE
Description: Delete a data connection..
Endpoint: /connections/{connectionid}
Parameters: /delete
Method: GET
Description: Return a list of deployment details..
Endpoint: /deployments
Parameters: /filter
Method: GET
Description: Return a specific deployment details..
Endpoint: /deployments/{deploymentid}
Parameters: /filter
Method: POST
Description: Create a new deployments..
Endpoint: /deployments
Parameters: /create
Method: PUT
Description: Update a deployments..
Endpoint: /deployments/{deploymentid}
Parameters: /update
Method: PATCH
Description: Partially update a deployments..
Endpoint: /deployments/{deploymentid}
Parameters: /update
Method: DELETE
Description: Delete a deployments..
Endpoint: /deployments/{deploymentid}
Parameters: /delete
Method: GET
Description: List the available documents..
Endpoint: /documents
Parameters: /filter
Method: GET
Description: Get a specific document..
Endpoint: /documents/{documentid}
Parameters: /filter
Method: POST
Description: Create a document..
Endpoint: /documents
Parameters: /create
Method: POST
Description: Create a new document version..
Endpoint: /documents/{documentid}/versions
Parameters: /create
Method: PUT
Description: Update a document..
Endpoint: /documents/{documentid}
Parameters: /update
Method: PATCH
Description: Partially update a document..
Endpoint: /documents/{documentid}
Parameters: /update
Method: DELETE
Description: Delete a document..
Endpoint: /documents/{documentid}
Parameters: /delete
Method: GET
Description: List events that have been captured..
Endpoint: /events
Parameters: /filter
Method: GET
Description: Retrieve a specific event..
Endpoint: /events/{eventid}
Parameters: /filter
Method: GET
Description: List all event views..
Endpoint: /event-views
Parameters: /filter
Method: GET
Description: Retrieve a specific event view..
Endpoint: /event-views/{eventviewid}
Parameters: /filter
Method: POST
Description: Create a new event view..
Endpoint: /event-views
Parameters: /create
Method: PUT
Description: Update an event view..
Endpoint: /event-views/{eventviewid}
Parameters: /update
Method: PATCH
Description: Partially update an event view..
Endpoint: /event-views/{eventviewid}
Parameters: /update
Method: DELETE
Description: Delete an event view..
Endpoint: /event-views/{eventviewid}
Parameters: /delete
Method: POST
Description: Create an event..
Endpoint: /events
Parameters: /create
Method: GET
Description: Return a list of groups..
Endpoint: /groups
Parameters: /filter
Method: GET
Description: Return a specific group..
Endpoint: /groups/{group_id}
Parameters: /filter
Method: POST
Description: Create a group..
Endpoint: /groups
Parameters: /create
Method: PUT
Description: Update a group..
Endpoint: /groups/{group_id}
Parameters: /update
Method: PATCH
Description: Partially update a group..
Endpoint: /groups/{group_id}
Parameters: /update
Method: DELETE
Description: Delete a group..
Endpoint: /groups/{group_id}
Parameters: /delete
Method: GET
Description: Return a list of insights..
Endpoint: /insights
Parameters: /filter
Method: GET
Description: Return a specific insight..
Endpoint: /insights/{id}
Parameters: /filter
Method: POST
Description: Create an insight..
Endpoint: /insights
Parameters: /create
Method: PUT
Description: Update an insight..
Endpoint: /insights/{id}/update
Parameters: /filter
Method: PATCH
Description: Partially update an insight..
Endpoint: /insights/{id}/update
Parameters: /filter
Method: DELETE
Description: Delete an insight..
Endpoint: /insights/{id}/delete
Parameters: /filter
Method: GET
Description: Return a list of integrations..
Endpoint: /integrations
Parameters: /filter
Method: GET
Description: Return a specific integration..
Endpoint: /integrations/{id}
Parameters: /filter
Method: POST
Description: Create an integration..
Endpoint: /integrations
Parameters: /create
Method: PUT
Description: Update an integration..
Endpoint: /integrations/{id}
Parameters: /update
Method: PATCH
Description: Partially update an integration..
Endpoint: /integrations/{id}
Parameters: /update
Method: DELETE
Description: Delete an integration..
Endpoint: /integrations/{id}
Parameters: /delete
Method: GET
Description: Return a list of issues..
Endpoint: /issues
Parameters: /filter
Method: GET
Description: Return a specific issue..
Endpoint: /issues/{id}
Parameters: /filter
Method: POST
Description: Create an issue..
Endpoint: /issues
Parameters: /create
Method: PUT
Description: Update an issue..
Endpoint: /issues/{id}
Parameters: /filter
Method:
Description: .
Endpoint:
Parameters:
FAQ
How do I authenticate with the Acquire APIs?
Authentication is handled via API keys. You can generate an API key from the Acquire dashboard.
What are the rate limits for the Acquire APIs?
The rate limit for each endpoint is specified in the API documentation. Exceeding the rate limit will result in a 429 Too Many Requests error.
How do I access the Sandbox environment?
To access the Sandbox environment, set the 'sandbox' parameter to 'true' when making API requests.
How do I sign up for a developer account?
You can sign up for a developer account at https://acquire.io/developers. A developer account gives you access to the Sandbox environment and API documentation.
How do I retrieve a list of all invoices?
To retrieve a list of all invoices, use the 'GET /invoices' endpoint. This endpoint returns a paginated list of invoices.