Biziq API (1.0)

The Biziq API is a collection of web services that allow you to receive payments from customers, be notified of those payments, refund them if necessary, among others.

The API endpoints are available through the following domains:

• For sandbox environment:

    https://sandboxapi.biziq.app/
  

• For production environment:

    https://api.biziq.app/
  

To check your credentials for the API you can go to the API tab on our software.

Server-to-server requests to the API you must be authenticated via Account ID and API Key. If you are associated to more than one company you may also need the Company VAT. To do so, include the following HTTP headers in your API requests:

accountid: <YOUR_ACCOUNT_ID>
apikey: <YOUR_API_KEY>
company_vat: <YOUR_COMPANY_VAT>

When these headers are missing or incorrect, a 401 HTTP status code is returned.

Biziq uses HTTP response status codes to indicate the success or failure of your API requests. If your request fails, Biziq returns an error using the appropriate status code.

In general, there are three status code ranges you can expect:

• 2xx success status codes confirm that your request worked as expected
• 4xx error status codes indicate an error because of the information provided (for example, a required parameter was omitted).
• 5xx error status codes are rare and indicate an error with Biziq’s servers.

Some 4xx errors that could be handled programmatically include an error code (a short string with a brief explanation) as a value for code.

Below is a list of possible error codes that can be returned, along with additional information about how to resolve them.

Authentication Error

This error can have multiple potential causes. Here are some examples:

• Missing/Invalid aaccountid and/or apikey Headers
• Your account has been blocked
• You don't enough permissions to the action requested

Invalid Content Type Error

This error can only have one cause, you provided an invalid/unsupported content type header.

Invalid JSON Error

This error happens when you provide a bad formated JSON payload.

Invalid Params Error

This error indicates the information provided was incorrect of insufficient (for example, a required parameter was omitted).

Internal Error

This error indicates that an unexpected error ocurred on our servers.

This segment outlines various requests that users can execute to effectively manage their personal information within the Biziq platform.

This segment provides comprehensive insights and guidelines on leveraging the company settings capabilities of the Biziq API.

This segment provides comprehensive insights and guidelines on leveraging the invoicing capabilities of the Biziq API. Whether you’re initiating transactions, managing financial records, or enhancing your invoicing workflows, this section serves as your go-to resource. Endpoints for managing Clients under the Invoicing section.

This segment provides comprehensive insights and guidelines on leveraging the invoicing capabilities of the Biziq API. Whether you’re initiating transactions, managing financial records, or enhancing your invoicing workflows, this section serves as your go-to resource. Endpoints for managing credit notes under the Invoicing section.

This segment provides comprehensive insights and guidelines on leveraging the invoicing capabilities of the Biziq API. Whether you’re initiating transactions, managing financial records, or enhancing your invoicing workflows, this section serves as your go-to resource. Endpoints for managing items under the Invoicing section.

This segment provides comprehensive insights and guidelines on leveraging the invoicing capabilities of the Biziq API. Whether you’re initiating transactions, managing financial records, or enhancing your invoicing workflows, this section serves as your go-to resource. Endpoints for managing invoices under the Invoicing section.

This segment provides comprehensive insights and guidelines on leveraging the invoicing capabilities of the Biziq API. Whether you’re initiating transactions, managing financial records, or enhancing your invoicing workflows, this section serves as your go-to resource. Endpoints for managing proformas under the Invoicing section.