Query String Parameters

contracts

Filters 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

Filters results by the transaction currency.

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

currency=USD

format

Specifies the format of the results.

Values:

• json (default)
• csv

format=csv

from_date, to_date

For a custom period, these parameters allow 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, these parameters allow 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

Queries 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

paymentType

Filters 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
• 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

payoutCycle

Filters results by the payout cycle.

A BlueSnap assigned value identifying the payout cycle.

payoutCycle=2016D303

period (Required)

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. For a custom period, be sure to include the from_date and to_date parameters.

period=THIS_MONTH

products

Filters results by a specific product or list of products.

If not defined, data is returned for all products.

products=444555

products=444555,888999

region

Region where deposit is processed. Only available for merchants on regional payout.

region=UK

skuType

Filters results by the SKU type.

Values:

• ONE_TIME
• RECURRING

skuType=ONE_TIME

transactionType

Filters results by the transaction type.

Values:

• CHARGEBACK
• SALE
• REFUNDNote: There are multiple types of fees, manual adjustments, and reserves not listed here.

transactionType=SALE

vendor

Filters results by a marketplace vendor.

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

vendor=513499

whitelabel

Indicates whether to remove BlueSnap from report column names.

Values:

• Y
• N

whitelabel=Y

format

Specifies the format of the results.

Values:

• json (default)
• csv

format=csv

forvendorid

Runs 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, these parameters allow 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

nonProcessingFees

Includes 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, RDR, and REFUND events. This is the default behavior.

nonProcessingFees=1

payoutCurrency

Filters 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

Filters results by the payout cycle.

A BlueSnap assigned value identifying the payout cycle.

payoutCycle=2016D303

period

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. For a custom period, be sure to include the from_date and to_date parameters.

period=THIS_MONTH

region

Region where deposit is processed. Only available for merchants on regional payout.

region=UK

transactionType

Filters results by the transaction type.

Values:

• CHARGEBACK
• SALE
• REFUNDNote: There are multiple types of fees, manual adjustments, and reserves not listed here.

transactionType=SALE

whitelabel

Indicates whether to remove BlueSnap from report column names.

Values:

• Y
• N

whitelabel=Y