Test the API with Postman

Use the official Asaas collection to test the endpoints in Sandbox before implementing the requests in your application.

When to use it

Use the collection to:

• explore the API endpoints;
• validate authentication, headers, and URLs;
• test requests before writing code;
• reproduce errors during development;
• share requests with your team.

Before you start

You need to:

1. Install Postman or access the web version.
2. Create an account in the Asaas Sandbox.
3. Generate an API key for the Sandbox.
4. Check the authentication requirements.

1. Make a copy of the collection

1. Access the official collection:

Open Asaas API in Postman

2. In the side menu, expand Asaas API and select Collection Asaas.

3. Click Fork in the upper right corner and choose the Workspace where you want to save the collection.

2. Configure the environment

Use the URL that matches your API key's environment:

Also configure the headers:

If the collection uses variables, update the base URL and the API key before sending the first request.

If the values are set directly in the request, review the URL and headers individually.

3. Test a request

1. Select an endpoint in Collection Asaas.
2. Confirm the environment URL.
3. Check the request headers.
4. Fill in the parameters or the body, when necessary.
5. Click Send.
6. Check the HTTP status and the response body.

A successful operation should return a 2xx status. The specific code depends on the endpoint used.

How to confirm authentication

If the key belongs to another environment, the API may return:

{
  "errors": [
    {
      "code": "invalid_environment",
      "description": "The provided API key does not belong to this environment"
    }
  ]
}

If the access_token header is not sent:

{
  "errors": [
    {
      "code": "access_token_not_found",
      "description": "The 'access_token' authentication header is required and was not found in the request"
    }
  ]
}

Common errors

Next steps

• Learn about the Sandbox
• Check the API authentication
• Learn how to manage your API keys
• Go to the API reference