Request Report Data

To fetch report data, specify your desired report type, time frame (separated by "from and "to"), format and columns according to the specifications below.

Request Body — REQUIRED
ReportCode string — REQUIRED Possible values: [ReconciliationReport, NewPlans, DebitReport, OutstandingAmounts, FundingReport, ShopperOutstanding]
From date-time UTC format, e.g. "2023-04-29T14:33:44.613Z"
To date-time UTC format, e.g. "2023-04-29T14:33:44.613Z"
Format ReportFormat2 Possible values: [CSV, JSON, XLSX]
SelectedColumns string[] Choose your columns from the available fields. Refer to Report Field Definitions for more info on each field. Notes: When the SelectedColumns tag is empty ([]), the system will return default columns If a column's values don't exist, then the system skips it and doesn't export it The order of columns in the exported report depends on the columns' order in the JSON body Exported results are not sorted Reconciliation Report Columns Merchant_Name, Plan_Number, Gateway_Transaction_Process_DateTime, Plan_Funding_Type,Gateway_Transaction_ID, Gateway_Transaction_Amount,Gateway_Transaction_Type, Gateway_Transaction_Currency,Installment_Number, Number_Of_Installments, Is_Full_Captured, Order_Number, Card_Brand, Card_Type, Terminal_Name, Plan_Amount,Shopper_Name, Shopper_Email New Plans Report Columns Plan_Number, Order_Number, Created_Date, Total_Plan_Amount, Currency, Plan_Status, Merchant_Name, Number_Of_Installments, Business_Unit_Name, Card_Type,Card_Brand, Shopper_Name, Shopper_Email, Funding_Type, Terminal_Name, Plan_on_Hold, Paid_Installments, Delayed_Installments, Outstanding_Installments,Outstanding_Amount, Credit_Refund_Amount, Non_Credit_Refund_Amount, Plan_Created_By,Plan_End_Date, Agent_Name Debit Report Columns Date, Transaction ID, Merchant Name, Business Unit,Plan_Number, Terminal_Name, Settlement_Currency, Plan_Amount_After_Exchange, Total_Number_Of_Installments, Installment_Number, Order_Number, Consumer_Name, Charged_Amount, Debit_Merchant_Date, Debit_Reason, Card_Type, Card_Brand, Amount_for_Funding_Shopper_Transaction_Currency, Transaction_Currency, Transaction_Amount, Exchange_Rate, Legacy_Installment_Number Outstanding Amount Report Columns Plan_Number, Installment_Number, Outstanding_Amount,Order_Number, Process_Date_Time, Currency, Business_Unit, Merchant_Name, Terminal_Name, Plan_Created_Date, Number_Of_Installments, Plan_Status, Plan_Funding_Type, Shopper_Name, Shopper_Email Funding Report Columns Merchant_Name, Business_Unit, Terminal_Name, Plan_Number, Created_Date, First_Charge_Date,Transaction_Currency, Transaction_Amount, Exchange_Rate, Settlement_Currency, New_Amount_After_Exchange, Reserve, Variable_Fee, Fixed_Fee, Number_Of_Installments, Order_Number, Consumer_Name, Consumer_Email, Transfer_Amount, Finance_Date, Card_Type, Card_Brand Shopper Outstanding Report Columns Report_Date, Business_Unit, Merchant,Installment_Plan_Number, Total_Plan_Amount, Order_Number, Plan_Activation_Date, Currency, Number_Of_Installments, Status, Paid_Amount, Outstanding_Amount, Paid_Installments, Outstanding_Installments, Last_Collection_Date, Amount_For_Next_0To30_Days, Amount_For_Next_31To60_Days, Amount_For_Next_61To90_Days, Amount_For_Next_91PlusDays

Responses
200 Schema — OPTIONAL Errors object[] — OPTIONAL Code string — OPTIONAL Message string — OPTIONAL AdditionalInfo string — OPTIONAL StatusCode int32 TraceId string — OPTIONAL IsSuccess boolean DelliveredTo DeliveryMethod — OPTIONAL Possible values: [0, 1] FileUrl string — OPTIONAL
401 Schema — OPTIONAL Errors object[] — OPTIONAL Code string — OPTIONAL Message string — OPTIONAL AdditionalInfo string — OPTIONAL StatusCode int32 TraceId string — OPTIONAL IsSuccess boolean
403 Schema — OPTIONAL Errors object[] — OPTIONAL Code string — OPTIONAL Message string — OPTIONAL AdditionalInfo string — OPTIONAL StatusCode int32 TraceId string — OPTIONAL IsSuccess boolean
404 Schema — OPTIONAL Errors object[] — OPTIONAL Code string — OPTIONAL Message string — OPTIONAL AdditionalInfo string — OPTIONAL StatusCode int32 TraceId string — OPTIONAL IsSuccess boolean
500 Schema — OPTIONAL Errors object[] — OPTIONAL Code string — OPTIONAL Message string — OPTIONAL AdditionalInfo string — OPTIONAL StatusCode int32 TraceId string — OPTIONAL IsSuccess boolean