CHcheckout
Reports

Get report details

Use this endpoint to retrieve a specific report using its ID.

get/reports/{id}

Request

Path parameters

idstring required
Example:rpt_lmmldzousk7etoqijqundqexa4

The ID of the report to retrieve.

Response

Report details retrieved successfully

idstring

The report ID.

created_onstring date-time

The date and time the report was created.

last_modified_onstring date-time

The date the report was last modified.

type'Authentication' | 'Balance' | 'BalanceBreakdown' | 'BankPayouts' | 'CardPayouts' | 'Disputes' | 'FinancialActions' | 'FinancialActionsByPayout' | 'FraudDetection' | 'IssuingAuthorizations' | 'IssuingCards' | 'IssuingChargebacks' | 'IssuingPresentments' | 'IssuingSettlementActivity' | 'IssuingSettlementSummary' | 'Manifest' | 'Payments' | 'PayoutSummary' | 'RealTimeAccountUpdater' | 'ReportedFraudulentTransactions' | 'Retrievals' | 'SettlementBreakdown' | 'SettlementStatement'

The report type.

descriptionstring

The report description.

tagsstring[]

The list of tags for filtering.

fromstring date-time

The reporting period's start date and time.

tostring date-time

The reporting period's end date and time.

Example response

{
  "id": "rpt_lmmldzousk7etoqijqundqexa4",
  "created_on": "2022-02-18T13:00:12.3570000+00:00",
  "last_modified_on": "2022-02-18T13:16:12.3570000+00:00",
  "description": "Reconciliation Report for X.",
  "account": {
    "client_id": "cli_bvaelhppmfiufdnatam37wrfc4",
    "entity_id": "ent_znj4ih5kn4fuxiaquoudv5mvwy"
  },
  "tags": [
    "payout_id:pay_123456789"
  ],
  "from": "2022-02-17T12:00:00.0000000+00:00",
  "to": "2022-02-18T12:00:00.0000000+00:00",
  "files": [
    {
      "id": "file_7ysmgfkj4ipunduud22uf73iey",
      "filename": "financial-actions_ent_znj4ih5kn4fuxiaquoudv5mvwy_20220218_000000001drl_1.csv",
      "format": "CSV"
    }
  ]
}

Changes

No recorded changes to this operation across all 1 revision of this API.