{"title":"DPP Reports Experience API","description":"This application will be useful to retrieve multiple reports.","baseUri":"https://api.deluxe.com{path}","version":1,"mediaType":"application/json","baseUriParameters":{"path":{"description":"The baseUri uses a dynamic {path} parameter to support path-based routing, \"/dpp/v1\" will become the standard to support the new routing model.","type":"string","enum":["/dpp/v1"],"default":"/dpp/v1","required":true}},"annotationTypes":{"internal":{"type":"boolean","description":"Flag to indicate whether the resource/endpoint documenrtation is intended for internal use. If the internal flag is set to true, the documentation should not be visible."}},"uses":{"Health":"exchange_modules/4c08e201-c97b-4665-9310-e3ac89ce1c28/api-health-check/1.0.1/api-health-check.raml","StandardErrors":"exchange_modules/4e9f20a7-a4a1-4b0c-905c-e0c8b30364f7/api-standard-errors-fragment/2.0.4/api-standard-errors.raml","SecuritySchemas":"exchange_modules/4c08e201-c97b-4665-9310-e3ac89ce1c28/api-standard-security/1.0.3/api-standard-security.raml","Common":"/libraries/CommonLibrary.raml","CcDailySettlement":"/libraries/CcDailySettlement.raml","AchDailySettlement":"/libraries/AchDailySettlement.raml","CcMonthlyStatment":"/libraries/CcMonthlyStatment.raml","AchMonthlyStatment":"/libraries/AchMonthlyStatment.raml","TransAuth":"/libraries/TransAuth.raml","TransCaptured":"/libraries/TransCaptured.raml","TransSettled":"/libraries/TransSettled.raml","CustomReports":"/libraries/CustomReports.raml"},"securedBy":["SecuritySchemas.oidcEnforcement"],"/":{"displayName":"Health Check","description":"This endpoint allows to get the application health status.","type":"Health.check","is":["StandardErrors.errorHandler"]},"/reports":{"displayName":"Reports","description":"The Reports resource allows you to generate and retrieve detailed reports on various transactions and financial activities within a specified date range.It supports different types of reports, such as credit card reconciliations, ACH settlements, and more, enabling merchants to efficiently monitor and analyze their payment processing data. The resource provides pagination support, allowing users to navigate through large datasets.Reports can include information such as transaction IDs, dates, amounts, payment methods, settlement statuses, and batch details, helping merchants manage and reconcile their financial records effectively.\n","post":{"displayName":"Custom Reports","description":"The Custom Report API endpoint allows users to fetch a report based on a specified title and date range. Query parameters page and pageSize enable pagination of the report results for efficient data retrieval.","is":["StandardErrors.errorHandler","Common.Headers"],"queryParameters":{"page":{"description":"Page number for pagination","type":"number","required":false,"example":1},"pageSize":{"description":"Number of results per page","type":"number","required":false,"example":2}},"body":{"application/json":{"type":"CustomReports.Request","example":"/examples/CustomReportsRequest.json"}},"responses":{"200":{"body":{"application/json":{"type":"CustomReports.Response","example":"/examples/CustomReportsResponse.json"}}}}},"/ccdailysettlement":{"displayName":"Credit Card Daily Settlement Report","(internal)":true,"description":"This endpoint allows you to retrieve the Credit Card Settlement Reports on daily basis","get":{"displayName":"Retrieve Credit Card Daily Settlement Report","description":"This endpoint allows you to retrieve the Credit Card Settlement Reports on daily basis","is":["StandardErrors.errorHandler","Common.Headers","Common.QueryParameters"],"responses":{"200":{"body":{"application/json":{"type":"CcDailySettlement.Response","example":"/examples/CcDailySettlementResponse.json"}}}}}},"/achdailysettlement":{"displayName":"ACH Daily Settlement Report","(internal)":true,"description":"This endpoint allows you to retrieve the ACH Settlement Reports on daily basis","get":{"displayName":"Retrieve ACH Daily Settlement Report","description":"This endpoint allows you to retrieve the ACH Settlement Reports on daily basis","is":["StandardErrors.errorHandler","Common.Headers","Common.QueryParameters"],"responses":{"200":{"body":{"application/json":{"type":"AchDailySettlement.Response","example":"/examples/AchDailySettlementResponse.json"}}}}}},"/ccmonthlystatement":{"displayName":"Credit Card Monthly Fees Statement Report","(internal)":true,"description":"This endpoint allows you to retrieve the  Credit Card Fees Statment on Monthly basis","get":{"displayName":"Retrieve Credit Card Monthly Fees Statement","description":"This endpoint allows you to retrieve the  Credit Card Fees Statment on Monthly basis","is":["StandardErrors.errorHandler","Common.Headers","Common.QueryParameters"],"responses":{"200":{"body":{"application/json":{"type":"CcMonthlyStatment.Response","example":"/examples/CcMontlyStatementResponse.json"}}}}}},"/achmonthlystatement":{"displayName":"ACH Monthly Fees Statement Report","(internal)":true,"description":"This endpoint allows you to retrieve the ACH Fees Statment report on Monthly basis","get":{"displayName":"Retrieve ACH Monthly Fees Statment","description":"This endpoint allows you to retrieve the ACH Fees Statment on Monthly basis","is":["StandardErrors.errorHandler","Common.Headers","Common.QueryParameters"],"responses":{"200":{"body":{"application/json":{"type":"AchMonthlyStatment.Response","example":"/examples/AchMontlyStatementResponse.json"}}}}}},"/transauth":{"displayName":"Authorized Transactions","(internal)":false,"description":"This endpoint allows you to retrieve the Authorized Transactions on given date range","get":{"displayName":"Retrieve Authorized Transactions","description":"This endpoint allows you to retrieve the Authorized Transactions on given date range","is":["StandardErrors.errorHandler","Common.Headers","Common.QueryParameters"],"responses":{"200":{"body":{"application/json":{"type":"TransAuth.Response","example":"/examples/TransAuthResponse.json"}}}}}},"/transcaptured":{"displayName":"Captured Transactions","(internal)":false,"description":"This endpoint allows you to retrieve the Captured Transactions on given date range","get":{"displayName":"Retrieve Captured Transactions","description":"This endpoint allows you to retrieve the Captured Transactions on given date range","is":["StandardErrors.errorHandler","Common.Headers","Common.QueryParameters"],"responses":{"200":{"body":{"application/json":{"type":"TransCaptured.Response","example":"/examples/TransCapturedResponse.json"}}}}}},"/transsettled":{"displayName":"Settled Transactions","(internal)":false,"description":"This endpoint allows you to retrieve the settled transactions on given date range","get":{"displayName":"Retrieve Settled Transactions","description":"This endpoint allows you to retrieve the settled transactions on given date range","is":["StandardErrors.errorHandler","Common.Headers","Common.QueryParameters"],"responses":{"200":{"body":{"application/json":{"type":"TransSettled.Response","example":"/examples/TransSettledResponse.json"}}}}}}}}