Query Parameters

Supported query parameters for our custom reporting API

When you run your custom report, you have the option to filter the results using query string parameters, which are described in detail on this page.

See:

Supported parameters per report category

This table outlines the supported query string parameters per report category. For details on any of the parameters listed, refer to Parameter descriptions. You can also click the parameter to go directly to its definition.

Parameter descriptions

This table provides descriptions of all the query string parameters. Note: Refer to Supported parameters per report category to see which parameters are applicable to your report.

Parameter

Description

Example

contracts

Allows you to filter results for a specific contract or a list of contracts.

Value is a number or a comma‑separated list of numbers.

To use this parameter, include the products parameter as well.

If this parameter is not defined, data is returned for all contracts under the specified product.

contracts=123456
contracts=123456,987612

currency

Allows you to filter results by the transaction currency.

Value is the three‑letter currency code (uppercase).

currency=USD

format

Allows you to specify the format of the results.

Values: json (default) csv

format=csv

forvendorid

Allows you to run a report on behalf of a vendor.

Value is the vendor's ID, which is a unique value assigned by BlueSnap.

forvendorid=513499

from_date to_date

For a custom period, this parameters allows you to specify the date range for the report results. Format is MM/DD/YYYY or YYYY‑MM‑DD

period=CUSTOM
&from_date=01/30/2020
&to_date=03/30/2020

from_time to_time

For a custom period, this parameter allows you to to filter the report by the transaction time (in PST).

Default values for from_time and to_time are 00:00:00 and 23:59:59, respectively.

period=CUSTOM
&from_date=07/01/2020
&from_time=05:25:02
&to_date=07/31/2020
&to_time=23:55:58

merchantIds

This parameter allows you to query your report using multiple merchant IDs. It should contain a comma-separated list of numbers, where the numbers are merchants IDs. This can only be used with the API credentials of the associated parent VID (MID) or the associated referral partner ID.

merchantIds=402650,612355,382526

nextPageToken

This parameter is applicable to report pagination. It's used to get the next page of results.

nextPageToken=bmV4dHBhZ2V0b2tlbg==

nonProcessingFees

Allows you to include non-processing fees in your report. When you pass nonProcessingFees=1, the report will show all payout types, with non-processing fees included.

If any other value is passed, the report will only show CHARGE, CHARGEBACK, and REFUND events. This is the default behavior.

nonProcessingFees=1

pageSize

This parameter is applicable to report pagination. It's used to specify the number of results returned in each API call. This parameter is only relevant to the first API call.

If not specified, each page contains a maximum of 10,000 rows

pageSize=50

paymentType

Allows you to filter the results by payment method.

Values: Alipay Apple Pay Balance Boleto Bancario Business Check Cashier Check cashU Credit Card Direct Debit Electronic Check GlobalCollect Cheque Google Pay Tokenized Card Local Bank Transfer Money Order None Offline Electronic Check Online banking PayPal PaySafeCard Personal Check Prepaid Purchase Order SEPA Direct Debit Skrill (Moneybookers) Ukash Wallie WebMoney Wire Transfer

paymentType=Credit%20Card

payoutCurrency

Allows you to filter the results by the payout currency.

Value is the 3‑digit code (uppercase) of the currency of the bank account where you receive your payout.

payoutCurrency=USD

payoutCycle

Allows you to filter results by the payout cycle.

A BlueSnap assigned value identifying the payout cycle

payoutCycle=2016D303

period

The period for which you would like to view report results.

Values: THIS_MONTH LAST_WEEK LAST_MONTH LAST_3_MONTHS LAST_6_MONTHS LAST_12_MONTHS CUSTOM (see below)

For a custom period, be sure to include the from_date and to_date parameters.

period=THIS_MONTH

products

Allows you to filter results by a specific product or list of products.

If not defined, data is returned for all products

products=444555
products=444555,888999

skuType

Allows you to filter results by the SKU type.

Values: ONE_TIME RECURRING

skuType=ONE_TIME

transactionType

Allows you to filter results by the transaction type.

Values: CHARGEBACK SALE REFUND

Note: There are multiple types of fees, manual adjustments, and reserves not listed here.

transactionType=SALE

vendor

Allows you to filter results by a marketplace vendor.

Value is the vendor's ID, which is a unique value assigned by BlueSnap.

vendor=513499