| Report | Query |
|---|---|
| ACH notification of change (NOC) | achNotificationsOfChange() |
| ACH return | achReturns() |
| Allocation details | allocations() |
| Authorization summary | authorizationSummaries() |
| Fee | fees() |
| Fee summary | feeSummaries() |
| Funding dispute events | fundingDisputeEvents() |
| Funding summary | fundingSummaries() |
| Funding transaction | fundingTransactions() |
| Transaction | paymentTransactions() |
| Transaction summary | paymentTransactionSummaries() |
Generate a report
- Prepare the pertinent report query.
-
Create an
$inputvariable to store your filters, sort order and pagination, and pass it into the query.Input Description whereUsed to filter the data and specify the groupings on summary reports. All reports require a date filter (unless noted), and offer a number of optional filters. orderByUsed to specify the order of the results. Available only on summary reports. pagingUsed to specify how many records to return using: skiptells the query to “skip” over a specified number of records. If you are requesting all records to be contained within a single page, set this field toskip:0, or if you plan to request the results across multiple pages, set this field to the number of records you want returned on the given page, e.g.,skip:50.takeis used to limit the number of records returned after the skip. e.g., Ifskip:0, take:100, then the response will return the first 100 records, i.e., rows 1-100. Ifskip:100, take:100, then the response will return the second set of 100 records, i.e., rows 101-200.
For reports in which you expect a large number of records, e.g., tens or hundreds of thousands (which is typical for itemized transaction reports like Transaction, Funding transaction, or Fee), consider returning the records in sets of500or1000or more. For summmary reports, where there are not as many rows, a lower skip and take usually fine, e.g.,skip:0, take:100.
Experiment to see what works best for you and your reports. -
List the fields you want returned within the query’s
itemsfield.
ACH notification of change
An itemized list of NOCs for a given activity date for ACH transactions.Steps
-
Query
achNotificationsOfChange(input:$input) -
Create an
$inputvariable to store your AchNotificationOfChangeInput filters, sort order and pagination, and pass it into the query.Filter Description activityDateThe date the notification of change was received by Tesouro. paymentIdA unique 36 character identifier created by Tesouro and assigned to a group of transactions in the same payment request cohort. e.g., An ACH bank transfer, refund, notification of change, or ACH return -
List the ach notification of change fields you want returned within the
itemsfield.
Example
Query
Inputs
Response
ACH return
An itemized list of ACH returns for a given activity date for ACH transactions.Steps
-
Query
achReturns(input:$input) -
Create an
$inputvariable to store your AchReturnsInput filters, sort order and pagination, and pass it into the query.Filter Description idThe unique id of the ach return that was generated by Tesouro. acceptorIdThe unique, 36 character identifier assigned to the entity providing the goods or services to the customer. Other processors may refer to this as the Merchant ID (MID), Outlet ID, or Customer number. activityDateThe date the notification of change was received by Tesouro. reasonCodeNacha Return Codes and associated ISO Status Reason Codes for returns and reversals from the External Code List. transactionActivityDateThe date Tesouro recognized the original ach payment request based upon the acceptor cutoff. transactionIdA unique identifier assigned by Tesouro to the original ach transaction. transactionReferenceA unique identifier from original ach transaction created by the entity holding the direct relationship with the Acceptor. Tesouro uses this identifier to manage idempotency. transactionTypeThe type of original ach transaction, e.g., Sale or Refund. -
List the ach return fields you want returned within the
itemsfield.
Example
Query
Inputs
Response
Allocation details
A comprehensive and detailed list of each money movement event for the partner and its acceptors for a given funds release date or activity date, including: settlements, disputes, processing fees, and partner-collected fees. Use this report to: reconcile partner and acceptor payments, get a detailed breakdown of a given funds release, and calculate acceptor profitability.Steps
-
Query
allocations(input:$input) -
Create an
$inputvariable to store your AllocationsInput filters, sort order and pagination, and pass it into the query.
To return money movements for just the acceptors or partner, filter byperspective.Filter Description acceptorIdA unique, 36 character identifier created by Tesouro and assigned to the entity providing the goods or services to the customer, such as a Merchant, a Submerchant of a Payment Facilitator, a Seller within a Marketplace, or a Biller of a Consumer Bill Payment Service Provider (CBPS). Historically, processors have called this identifier the Merchant ID (or MID), Outlet ID, or Customer number. activityDateThe date the allocation was applied. billableEventCurrencyThe currency of the billable event on which the allocation is assessed, formatted in ISO 4217 alphabetic code. feeTypeThe type of allocation, e.g., Settlement, Interchange, Network fee, Processor fee, Partner fee, etc. fundingCurrencyThe currency of the funded allocation, formatted in ISO 4217 alphabetic code. fundsReleaseDateThe date that Tesouro releases the funds from its bank account to the recipient’s bank account. fundsTransferidA unique identifier created and used by Tesouro, and assigned to the transfer of money to a bank account, to identify a cohort of funded transactions making up the transfer. paymentBrandThe payment brand used, e.g., Visa, Mastercard, Discover, American Express, etc. paymentIdA unique 36 character identifier created by Tesouro and assigned to a group of transactions in the same payment request cohort. e.g., An authorization request, incremental authorization request, and the final capture would have the same paymentID. NOTE: This field will present a null, not applicable, or empty value if the fee is not tied to a specific transaction. perspectiveThe perspective of the allocation, which can be either ‘ACCEPTOR’ or ‘PARTNER’. This field is used to determine the perspective from which the allocation is reported. -
List the allocation fields you want returned within the
itemsfield.
Query
Inputs
Response with both perspectives for same money movement
Authorization summary
A summary of authorization counts and amounts for the given transaction date. Can grouped by acceptor, transaction currency, response code, payment brand, and more.Use this report to analyze your authorization rates and look for trends in declined transactions.
Steps
-
Query
authorizationSummaries(input:$input) -
Create an
$inputvariable to store your AuthorizationSummaryInput filters, sort order and pagination, and pass it into the query.Filter Description acceptorIdA unique, 36 character identifier created by Tesouro and assigned to the entity providing the goods or services to the customer, such as a Merchant, a Submerchant of a Payment Facilitator, a Seller within a Marketplace, or a Biller of a Consumer Bill Payment Service Provider (CBPS). Historically, processors have called this identifier the Merchant ID (or MID), Outlet ID, or Customer number. transactionActivityDateRequired. The date Tesouro recognized the payment request based upon the acceptor cutoff. Formatted as 2024-03-27 transactionCurrencyThe currency specified on the transaction request, in ISO 4217 alpha currency code format. -
List the authorization summary fields you want returned within the
itemsfield.
Example query
Query
Inputs
Response
Fee
An itemized list of fees for a given transaction date or funds release date.Steps
-
Query
fees(input:$input) -
Create an
$inputvariable to store your StandardFeeInput filters and pagination, and pass it into your query.Filter Description acceptorIdA unique, 36 character identifier created by Tesouro and assigned to the entity providing the goods or services to the customer, such as a Merchant, a Submerchant of a Payment Facilitator, a Seller within a Marketplace, or a Biller of a Consumer Bill Payment Service Provider (CBPS). Historically, processors have called this identifier the Merchant ID (or MID), Outlet ID, or Customer number. activityDateThe date the fee was applied. billableEventCurrencyThe currency of the billable event on which the fee is assessed, formatted in ISO 4217 alphabetic code. feeTypeThe type of fee, e.g., Interchange, Network, Processor, Partner, etc. fundingCurrencyThe currency of the funded transaction, formatted in ISO 4217 alphabetic code. fundsReleaseDateThe date that Tesouro releases the funds from its bank account to the recipient’s bank account. fundsTransferidA unique identifier created and used by Tesouro, and assigned to the transfer of money to a bank account, to identify a cohort of funded transactions making up the transfer. paymentBrandThe payment brand used, e.g., Visa, Mastercard, Discover, American Express, etc. paymentIdA unique 36 character identifier created by Tesouro and assigned to a group of transactions in the same payment request cohort. e.g., An authorization request, incremental authorization request, and the final capture would have the same paymentID. NOTE: This field will present a null, not applicable, or empty value if the fee is not tied to a specific transaction. perspectiveThe perspective of the allocation, which can be either ‘ACCEPTOR’ or ‘PARTNER’. This field is used to determine the perspective from which the allocation is reported. -
List the fee fields you want returned within the
itemsfield. NOTE: Transaction-level fields will present a null, “not applicable”, or empty value if the fee is not tied to a specific transaction.
Example
Query
Inputs
Response
Fee summary
A summary of fee counts and amounts, grouped by acceptor and fee type, for the given transaction date or funds release date. Use this report to understand the costs of your Merchant Services account.Steps
-
Query
feeSummaries(input:$input) -
Create an
$inputvariable to store your FeeSummaryInput filters, sort order and pagination, and pass it to your query.
Note: A date filter, eitherfeeActivityDateorfundsReleaseDate, is required.Filter Description acceptorIdA unique, 36 character identifier created by Tesouro and assigned to the entity providing the goods or services to the customer, such as a Merchant, a Submerchant of a Payment Facilitator, a Seller within a Marketplace, or a Biller of a Consumer Bill Payment Service Provider (CBPS). Historically, processors have called this identifier the Merchant ID (or MID), Outlet ID, or Customer number. feeActivityDateThe date the fee was applied. feeTypeThe type of fee, e.g., Interchange, Network, Processor, Partner, etc. fundingCurrencyThe currency of the funded transaction, formatted in ISO 4217 alphabetic code. fundsReleaseDateThe date that Tesouro releases the funds from its bank account to the recipient’s bank account. fundsTransferidA unique identifier created and used by Tesouro, and assigned to the transfer of money to a bank account, to identify a cohort of funded transactions making up the transfer. paymentBrandThe payment brand used used, e.g., Visa, Mastercard, Discover, American Express, etc. perspectiveThe perspective of the allocation, which can be either ‘ACCEPTOR’ or ‘PARTNER’. This field is used to determine the perspective from which the allocation is reported. -
List the fee summary values and attributes you want returned under
items.
Query
Inputs
Response
Funding dispute events
An itemized list of financially impacting disputes events (e.g., 1st chargebacks, representments) for the given funds release date.Steps
-
Query
fundingDisputeEvents(input:$input) -
Create an
$inputvariable to store your FundingDisputeEventInput filters, sort order and pagination, and pass it to your query.Filter Description acceptorIdA unique, 36 character identifier created by Tesouro and assigned to the entity providing the goods or services to the customer, such as a Merchant, a Submerchant of a Payment Facilitator, a Seller within a Marketplace, or a Biller of a Consumer Bill Payment Service Provider (CBPS). Historically, processors have called this identifier the Merchant ID (or MID), Outlet ID, or Customer number. dateOfEventThe date the dispute lifecycle event was reported. fundsTransferIdA unique identifier created by Tesouro and assigned to the transfer of money to a bank account that included funding of this dispute. fundsReleaseDateThe date the debited or credited funds for the dispute lifecycle were released. paymentBrandThe payment brand used used, e.g., Visa, Mastercard, Discover, American Express, etc. perspectiveThe perspective of the money movement, which can be either ‘ACCEPTOR’ or ‘PARTNER’. This field is used to determine the perspective from which the money movement is reported. -
List the funding dispute event fields you want returned within the
itemsfield.
Example
Query
Inputs
Response
Funding summary
A summary of funding activity (counts and amounts) by transaction date or funds release date. Use this report to understand the financial impact of daily sales, refunds, disputes, and associated fees, and to reconcile funds transfers to bank deposits.Steps
-
Query
fundingSummaries(input:$input) -
Create an
$inputvariable to store your FundingSummaryInput filters, sort order and pagination, and pass it to your query. Note: You must include a date range filter, eitherfundsReleaseDate- the date the trasnaction was funded, ortransactionActivityDate- the date the transaction was submitted.Filter Description acceptorIdA unique, 36 character identifier created by Tesouro and assigned to the entity providing the goods or services to the customer, such as a Merchant, a Submerchant of a Payment Facilitator, a Seller within a Marketplace, or a Biller of a Consumer Bill Payment Service Provider (CBPS). Historically, processors have called this identifier the Merchant ID (or MID), Outlet ID, or Customer number. fundingCurrencyThe currency specified on the transaction request, in ISO 4217 alpha currency code format. fundsReleaseDateA value created by Tesouro and sent with the funds transfer to the recipient’s bank for display on the bank statement. It includes information on who sent the money and the purpose of the payment. The recipient can use this value to help with bank and transaction reconciliation. fundsTransferIdA unique identifier created and used by Tesouro, and assigned to the transfer of money to a bank account, to identify a cohort of funded transactions making up the transfer. paymentBrandThe payment brand used used, e.g., Visa, Mastercard, Discover, American Express, etc. paymentChannelThe payment channel used used, e.g., Ecommerce, Retail, Mail Order Telephone Order, etc. perspectiveThe perspective of the money movement, which can be either towards the ‘ACCEPTOR’ or ‘PARTNER’. This field is used to determine the perspective from which the money movement is reported. transactionActivityDateRequired. The date Tesouro recognized the payment request based upon the acceptor cutoff. Formatted as 2024-03-27 -
List the funding summary fields you want returned within the
itemsfield.
Example
Query
Inputs
Response
Funding transaction
An itemized list of transactions that are in the process of being funded or were released for funding, filtered by transaction date or the date funds were released. Use this report to reconcile your payments back to your orders in order to move them to Account Receivable.Steps
-
Query
fundingTransactions(input: $input) -
Create an
$inputvariable to store your FundingTransactionInput filters, sort order and pagination, and pass it to your query.
Note: You must include a date range filter, eitherfundsReleaseDate- the date the trasnaction was funded, ortransactionActivityDate- the date the transaction was submitted. Results are automatically sorted by the specified date filter, descending.Filter Description acceptorIdA unique, 36 character identifier created by Tesouro and assigned to the entity providing the goods or services to the customer, such as a Merchant, a Submerchant of a Payment Facilitator, a Seller within a Marketplace, or a Biller of a Consumer Bill Payment Service Provider (CBPS). Historically, processors have called this identifier the Merchant ID (or MID), Outlet ID, or Customer number. fundingCurrencyThe currency specified on the transaction request, in ISO 4217 alpha currency code format. fundsReleaseDateA value created by Tesouro and sent with the funds transfer to the recipient’s bank for display on the bank statement. It includes information on who sent the money and the purpose of the payment. The recipient can use this value to help with bank and transaction reconciliation. fundsTransferIdA unique identifier created and used by Tesouro, and assigned to the transfer of money to a bank account, to identify a cohort of funded transactions making up the transfer. paymentBrandThe payment brand used used, e.g., Visa, Mastercard, Discover, American Express, etc. paymentChannelThe payment channel used used, e.g., Ecommerce, Retail, Mail Order Telephone Order, etc. perspectiveThe perspective of the money movement, which can be either towards the ‘ACCEPTOR’ or ‘PARTNER’. This field is used to determine the perspective from which the money movement is reported. transactionActivityDateRequired. The date Tesouro recognized the payment request based upon the acceptor cutoff. Formatted as 2024-03-27 -
List the funding transaction fields you want returned in the
itemsfield.
Example
Query
Inputs
Response
Transaction
A list of transaction requests (including those that will be conveyed to another processor for funding) submitted on the pertinent transaction activity dates. Use this report as an operational tool to reconcile against your internal record of submitted transactions.Steps
-
Query
paymentTransactions(input:$input) -
Create an
$inputvariable to store your PaymentTransactionsInput filters and pagination, and pass it to your query.
Note thattransactionActivityDateis a required filter.Filter Description acceptorIdA unique, 36 character identifier created by Tesouro and assigned to the entity providing the goods or services to the customer, such as a Merchant, a Submerchant of a Payment Facilitator, a Seller within a Marketplace, or a Biller of a Consumer Bill Payment Service Provider (CBPS). Historically, processors have called this identifier the Merchant ID (or MID), Outlet ID, or Customer number. paymentBrandThe payment brand used used, e.g., Visa, Mastercard, Discover, American Express, etc. paymentChannelThe payment channel used used, e.g., Ecommerce, Retail, Mail Order Telephone Order, etc. paymentFundingSourceThe source of the customer’s funds, e.g., credit, debit, pre-paid, cash. paymentIdA unique 36 character identifier created by Tesouro and assigned to a group of transactions in the same payment request cohort. e.g., An authorization request, incremental authorization request, and the final capture would have the same paymentID. processorResponseCodeA response code provided Tesouro indicating whether the transaction was approved or declined. transactionActivityDateREQUIRED. The date Tesouro recognized the payment request based upon the acceptor cutoff. Formatted as 2024-03-27. The results will be sorted by this field, descending. transactionCurrencyThe currency specified on the transaction request, in ISO 4217 alpha currency code format. transactionIdA unique 36 character identifier assigned by Tesouro for every transaction request received. transactionTypeThe type of transaction, e.g., Authorization, Refund authorization, or Incremental authorization. -
List the pertinent payment transaction fields you want returned within the
itemsfield. To avoid nullable values, and to keep the data relevant, each transaction type returns its own pertinent set of fields depending on the approved or declined response.
Example
Query
Inputs
Response
Transaction summary
A summary of transaction counts and amounts. Use this report to reconcile transactions against your internal record of submitted transactions.Steps
-
Query
paymentTransactionSummaries(input:$input) -
Create an
$inputvariable to store your PaymentTransactionSummaryInput filters, sort order and pagination, and pass it to your query.Filter Description acceptorIdA unique, 36 character identifier created by Tesouro and assigned to the entity providing the goods or services to the customer, such as a Merchant, a Submerchant of a Payment Facilitator, a Seller within a Marketplace, or a Biller of a Consumer Bill Payment Service Provider (CBPS). Historically, processors have called this identifier the Merchant ID (or MID), Outlet ID, or Customer number. paymentChannelThe payment channel used used, e.g., Ecommerce, Retail, Mail Order Telephone Order, etc. transactionActivityDateRequired. The date Tesouro recognized the payment request based upon the acceptor cutoff. Formatted as 2024-03-27 transactionCurrencyThe currency specified on the transaction request, in ISO 4217 alpha currency code format. transactionTypeThe type of transaction, e.g., Authorization, Capture, Refund, Reversal, Incremental authorization, Card verification, etc. -
List the transaction summary fields you want returned within the
itemsfield.
Example
Query
Inputs
Response