{"metadata":{"image":[],"title":"","description":""},"api":{"url":"","auth":"required","settings":"","results":{"codes":[]},"params":[]},"next":{"description":"","pages":[]},"title":"Query Parameters","type":"basic","slug":"query-parameters","excerpt":"","body":"When you [run your custom report](doc:run-custom-report), you have the option to filter the results using query string parameters, which are described in detail on this page. \n\nSee: \n* [Supported parameters per report category](#section-supported-parameters-per-report-category) - See which parameters are supported in your report.\n* [Parameter descriptions](#section-parameter-descriptions) - View the details of a specific parameter. \n\n# Supported parameters per report category\nThis table outlines the supported query string parameters per report category. For details on any of the parameters listed, refer to [Parameter descriptions](#section-parameter-descriptions). You can also click the parameter to go directly to its definition. \n[block:parameters]\n{\n  \"data\": {\n    \"h-0\": \"Report Category\",\n    \"h-1\": \"Supported Parameters\",\n    \"0-0\": \"**TransactionCategory**\",\n    \"0-1\": \"<a href=\\\"#contracts\\\" target=\\\"_blank\\\">`contracts`</a>\\n<a href=\\\"#currency\\\" target=\\\"_blank\\\">`currency`</a>\\n<a href=\\\"#format\\\" target=\\\"_blank\\\">`format`</a>\\n<a href=\\\"/v8976-Tools/docs/query-parameters#from_date\\\" target=\\\"_blank\\\">`from_date`, `to_date`</a>\\n<a href=\\\"#from_time\\\" target=\\\"_blank\\\">`from_time`, `to_time`</a>\\n<a href=\\\"#paymentType\\\" target=\\\"_blank\\\">`paymentType`</a>\\n<a href=\\\"#payoutCycle\\\" target=\\\"_blank\\\">`payoutCycle`</a>\\n<a href=\\\"#period\\\" target=\\\"_blank\\\">`period`</a>&nbsp;&nbsp;&nbsp;**Required**\\n<a href=\\\"#products\\\" target=\\\"_blank\\\">`products`</a>\\n<a href=\\\"#skuType\\\" target=\\\"_blank\\\">`skuType`</a>\\n<a href=\\\"#transactionType\\\" target=\\\"_blank\\\">`transactionType`</a>\\n<a href=\\\"#vendor\\\" target=\\\"_blank\\\">`vendor`</a>\",\n    \"1-0\": \"**PayoutCategory**\",\n    \"1-1\": \"<a href=\\\"#format\\\" target=\\\"_blank\\\">`format`</a>\\n<a href=\\\"#forvendorid\\\" target=\\\"_blank\\\">`forvendorid`</a>\\n<a href=\\\"#from_date\\\" target=\\\"_blank\\\">`from_date`, `to_date`</a>\\n<a href=\\\"#payoutCurrency\\\" target=\\\"_blank\\\">`payoutCurrency`</a>\\n<a href=\\\"#payoutCycle\\\" target=\\\"_blank\\\">`payoutCycle`</a>\\n<a href=\\\"#period\\\" target=\\\"_blank\\\">`period`</a>\\n<a href=\\\"#vendor\\\" target=\\\"_blank\\\">`vendor`</a>\"\n  },\n  \"cols\": 2,\n  \"rows\": 2\n}\n[/block]\n# Parameter descriptions\nThis table provides descriptions of all the query string parameters. **Note:** Refer to [Supported parameters per report category](#section-supported-parameters-per-report-category) to see which parameters are applicable to your report. \n[block:parameters]\n{\n  \"data\": {\n    \"h-0\": \"Parameter\",\n    \"h-1\": \"Description\",\n    \"h-2\": \"Example\",\n    \"4-0\": \"<span id=\\\"from_date\\\">`from_date`</span>\\n`to_date`\",\n    \"4-1\": \"For a custom period, this parameters allows you to specify the date range for the report results. Format is MM/DD/YYYY or YYYY&#8209;MM&#8209;DD\",\n    \"4-2\": \"```\\nperiod=CUSTOM\\n&from_date=01/30/2020\\n&to_date=03/30/2020\\n```\",\n    \"5-0\": \"<span id=\\\"from_time\\\">`from_time`</span>\\n`to_time`\",\n    \"5-1\": \"For a custom period, this parameter allows you to to filter the report by the transaction time (in PST). \\n\\nDefault values for `from_time` and `to_time` are **00:00:00** and **23:59:59**, respectively.\",\n    \"5-2\": \"```\\nperiod=CUSTOM\\n&from_date=07/01/2020\\n&from_time=05:25:02\\n&to_date=07/31/2020\\n&to_time=23:55:58\\n```\",\n    \"0-0\": \"<span id=\\\"contracts\\\">`contracts`</span>\",\n    \"0-1\": \"Allows you to filter results for a specific contract or a list of contracts. \\n\\nValue is a number or a comma&#8209;separated list of numbers. \\n\\nTo use this parameter, include the `products` parameter as well.\\n\\nIf this parameter is not defined, data is returned for all contracts under the specified product.\",\n    \"11-0\": \"<span id=\\\"period\\\">`period`</span>\",\n    \"11-1\": \"The period for which you would like to view report results. \\n\\nValues: \\n**THIS_MONTH**\\n**LAST_WEEK**\\n**LAST_MONTH**\\n**LAST_3_MONTHS**\\n**LAST_6_MONTHS**\\n**LAST_12_MONTHS**\\n**CUSTOM** (see below)\\n\\nFor a custom period, be sure to include the `from_date` and `to_date` parameters.\",\n    \"11-2\": \"`period=THIS_MONTH`\",\n    \"0-2\": \"`contracts=123456`\\n<br>\\n`contracts=123456,987612`\",\n    \"12-0\": \"<span id=\\\"products\\\">`products`</span>\",\n    \"12-1\": \"Allows you to filter results by a specific product or list of products. \\n\\nIf not defined, data is returned for all products\",\n    \"12-2\": \"`products=444555`\\n<br>\\n`products=444555,888999`\",\n    \"1-0\": \"<span id=\\\"currency\\\">`currency`</span>\",\n    \"1-1\": \"Allows you to filter results by the transaction currency. \\n\\nValue is the three&#8209;letter currency code (uppercase).\",\n    \"1-2\": \"`currency=USD`\",\n    \"2-0\": \"<span id=\\\"format\\\">`format`</span>\",\n    \"2-1\": \"Allows you to specify the format of the results. \\n\\nValues: \\n**json** (default)\\n**csv**\",\n    \"2-2\": \"`format=csv`\",\n    \"6-0\": \"<span id=\\\"nextPageToken\\\">`nextPageToken`</span>\",\n    \"6-1\": \"This parameter is applicable to [report pagination](doc:report-pagination). It's used to get the next page of results.\",\n    \"6-2\": \"`nextPageToken=bmV4dHBhZ2V0b2tlbg==`\",\n    \"7-0\": \"<span id=\\\"pageSize\\\">`pageSize`</span>\",\n    \"7-1\": \"This parameter is applicable to [report pagination](doc: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.  \\n\\nIf not specified, each page contains a maximum of 10,000 rows\",\n    \"7-2\": \"`pageSize=50`\",\n    \"8-0\": \"<span id=\\\"paymentType\\\">`paymentType`</span>\",\n    \"8-1\": \"Allows you to filter the results by payment method. \\n\\nValues:\\n**Alipay\\nApple Pay\\nBalance\\nBoleto Bancario\\nBusiness Check\\nCashier Check\\ncashU\\nCredit Card\\nDirect Debit\\nElectronic Check\\nGlobalCollect Cheque\\nGoogle Pay Tokenized Card\\nLocal Bank Transfer\\nMoney Order\\nNone\\nOffline Electronic Check\\nOnline banking\\nPayPal\\nPaySafeCard\\nPersonal Check\\nPrepaid\\nPurchase Order\\nSEPA Direct Debit\\nSkrill (Moneybookers)\\nUkash\\nWallie\\nWebMoney\\nWire Transfer**\",\n    \"8-2\": \"`paymentType=Credit%20Card`\",\n    \"9-0\": \"<span id=\\\"payoutCurrency\\\">`payoutCurrency`</span>\",\n    \"9-1\": \"Allows you to filter the results by the payout currency. \\n\\nValue is the 3‑digit code (uppercase) of the currency of the bank account where you receive your payout.\",\n    \"10-0\": \"<span id=\\\"payoutCycle\\\">`payoutCycle`</span>\",\n    \"10-1\": \"Allows you to filter results by the payout cycle. \\n\\nA BlueSnap assigned value identifying the payout cycle\",\n    \"10-2\": \"`payoutCycle=2016D303`\",\n    \"9-2\": \"`payoutCurrency=USD`\",\n    \"13-0\": \"<span id=\\\"skuType\\\">`skuType`</span>\",\n    \"13-1\": \"Allows you to filter results by the SKU type. \\n\\nValues: \\n**ONE_TIME**\\n**RECURRING**\",\n    \"13-2\": \"`skuType=ONE_TIME`\",\n    \"14-0\": \"<span id=\\\"transactionType\\\">`transactionType`</span>\",\n    \"14-1\": \"Allows you to filter results by the transaction type. \\n\\nValues: \\n**CHARGEBACK**\\n**SALE**\\n**REFUND**\",\n    \"14-2\": \"`transactionType=SALE`\",\n    \"15-0\": \"<span id=\\\"vendor\\\">`vendor`</span>\",\n    \"15-1\": \"Allows you to filter results by a marketplace vendor. \\n\\nValue is the vendor's ID, which is a unique value assigned by BlueSnap.\",\n    \"15-2\": \"`vendor=513499`\",\n    \"3-0\": \"<span id=\\\"forvendorid\\\">`forvendorid`</span>\",\n    \"3-1\": \"Allows you to run a report on behalf of a vendor. \\n\\nValue is the vendor's ID, which is a unique value assigned by BlueSnap.\",\n    \"3-2\": \"`forvendorid=513499`\"\n  },\n  \"cols\": 3,\n  \"rows\": 16\n}\n[/block]","updates":[],"order":8,"isReference":false,"hidden":false,"sync_unique":"","link_url":"","link_external":false,"_id":"60957f4cce403c0045a03252","createdAt":"2020-12-07T18:35:38.747Z","user":"5ea72d649148ff00653f6bbc","category":{"sync":{"isSync":false,"url":""},"pages":[],"title":"Custom Reporting API","slug":"dynamic-reporting-api","order":2,"from_sync":false,"reference":false,"_id":"60957f4cce403c0045a031f5","createdAt":"2020-11-03T16:46:14.694Z","version":"60957f4cce403c0045a03255","project":"57336fd5a6a9c40e00e13a0b","__v":0},"version":{"version":"8976-Tools","version_clean":"8976.0.0-Tools","codename":"3.38 Release","is_stable":false,"is_beta":false,"is_hidden":false,"is_deprecated":false,"categories":["60957f4cce403c0045a031e3","60957f4cce403c0045a031e4","60957f4cce403c0045a031e5","60957f4cce403c0045a031e6","60957f4cce403c0045a031e7","60957f4cce403c0045a031e8","60957f4cce403c0045a031e9","60957f4cce403c0045a031ea","60957f4cce403c0045a031eb","60957f4cce403c0045a031ec","60957f4cce403c0045a031ed","60957f4cce403c0045a031ee","5b34c737e0dca2000311de6a","60957f4cce403c0045a031ef","60957f4cce403c0045a031f0","60957f4cce403c0045a031f1","60957f4cce403c0045a031f2","60957f4cce403c0045a031f3","60957f4cce403c0045a031f4","60957f4cce403c0045a031f5"],"_id":"60957f4cce403c0045a03255","project":"57336fd5a6a9c40e00e13a0b","__v":0,"forked_from":"603fec227146110018e1daaf","createdAt":"2018-04-23T15:17:35.680Z","releaseDate":"2018-04-23T15:17:35.680Z"},"project":"57336fd5a6a9c40e00e13a0b","__v":0,"parentDoc":null}

BlueSnap Reporting & Tools

Reporting API

Custom Reporting API

3D Secure

Account Updater

Bank Directory

Convert Currency

Embedded Checkout

Encrypt/Decrypt Parameters

Hosted Payment Fields

Logos & Images

Payment Request Button

Retrieve Card Info

Retrieve Payment Methods

Secured Payment Collector

SEPA Direct Debit

Tax Quotes

User Management

Wallets

Query Parameters

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

nextPageToken

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

nextPageToken=bmV4dHBhZ2V0b2tlbg==

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

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