Reporting API Overview

The BlueSnap Reporting API is a RESTful web service that enables you to retrieve report data from 15+ pre-built reports and parse it according to your needs.


These are the Reporting API URLs for the BlueSnap environments:

  • Sandbox:{report_code}?{parameters}
  • Production:{report_code}?{parameters}

GET Request & Response Format

To obtain the report data, you will send a GET request with the report code and relevant parameters. The response will be provided in either JSON or CSV format, per your request. Paging is supported.

For details about the request and response, see GET Report Data.

For information about possible errors, see Errors.


Every API request must be authenticated using a HTTP Basic Authentication header, as follows:
Authorization: Basic {Base64 encoding of 'username:password'}
For example:
Authorization: Basic dXNlcm5hbWU6cGFzc3dvcmQ=

Your API user key and password can be found in the Merchant Portal, under Settings > API Settings. You will need different API credentials for the Sandbox and Production environments.

API Credentials

If you do not yet have API credentials, follow these steps to obtain them:

  1. In the Merchant Portal, log in to your Sandbox or Production account.
  2. Go to Settings > API Settings.
  3. Define your API password by entering it in the Password and Verify your password fields.
  4. In the New IP Address field, enter the IP address to be used for API calls. You can add up to fifteen IP addresses or subnets.
  5. Click Request API credentials.
    The credentials are generated and your new API user key is displayed.

Note: You will need a BlueSnap account in order to get API credentials. If you don't have an account yet, you can sign up for one here.