George's Workspace

Portal Reports API Builder

← Back to Home

Portal Reports API Builder

Build shareable Payrix API queries that mirror Portal Report CSV exports.

Current report category: Switch between Financial Reports and Standard Reports to build the matching API recipe for each Payrix Portal report family.

Report Inputs

Temporarily hard-coded for testing this report builder.
One clause per line. These are appended after the base report clauses.

Generated API Query

Endpoint 


      

        Headers
        
      

      


      

        cURL Example
        
      

      

      

      

      

      
Portal Column Mapping

      
    
        
  • Merchant ID from txns.merchant
    • 
        
  • Merchant Name / Merchant Dba from expanded merchant fields on /txns
    • 
        
  • Transaction Id / Transaction Date / Capture Date from id, created, captured
    • 
        
  • Terminal ID from terminal
    • 
        
  • Auth Code from authCode
    • 
        
  • Transaction Amount / Approved / Tax / Tip from total, approved, tax, tip
    • 
        
  • Payment Method / Last 4 / Card Brand / Cardholder from expanded payment and token relations when available
    • 
      


      

        Report logic used here: This template currently uses the confirmed portal inputs you provided: Report Date and Division, plus status[in]=0,1,3 as the current submitted-status assumption. Based on the local Payrix OpenAPI, /txns also has a separate settled field in addition to the numeric status field, but the exact search operator used by the portal for the “Not Settled” portion still needs to be confirmed before that clause is added automatically.
      

    

  


  

    

      Report API Matrix
      

        
        
        
      

    

    
Reference matrix for all report APIs currently modeled on this page. The examples focus on endpoint shape plus useful expand[...] patterns; standard pagination such as page[limit] and page[number] still applies even when not shown inline. All matrix calls are GET requests, and each row shows where the report-specific SEARCH header belongs. The PDF and Word exports use a clean report-by-report breakdown with endpoint details, headers, cURL calls, and report logic.

    

      

        
          

            Category
            Scope
            Report
            Endpoint(s) and SEARCH Header
            TOTALS
            Notes