GEgetkard
Files

Get Files

Changed on

Retrieves metadata for files associated with a specific issuer/organization. This endpoint supports pagination and sorting options to efficiently navigate through potentially large sets of file metadata. <b>Required scopes:</b> files.read

get/v2/issuers/{organizationId}/files/metadata

Request

  • Base URL
    https://rewards-api.getkard.com
  • URL
    https://rewards-api.getkard.com/v2/issuers/{organizationId}/files/metadata
  • Auth
    HTTP bearer

Path parameters

organizationIdstring required

Your issuer organization ID, provided by Kard

Query parameters

filter[dateFrom]string

Start of the range, applied to the file's original send date (sentAt), which a regenerated file keeps (format ISO8601). If not provided, defaults to current date minus 1 month.

filter[dateTo]string

End of the range, applied to the file's original send date (sentAt), which a regenerated file keeps (format ISO8601). If not provided, defaults to current date.

filter[fileType]'earnedRewardApprovedDailyReconciliationFile' | 'earnedRewardSettledDailyReconciliationFile' | 'payoutReconciliationFile' | 'monthlyReconciliationFile' | 'cardlinkedReconciliationFile'

Type of an issuer file. payoutReconciliationFile is the payout (monthly) reconciliation file; monthlyReconciliationFile is its deprecated alias, accepted in filter[fileType] and echoed back in type when used, to be removed in a later version. cardlinkedReconciliationFile is the daily card-linked reconciliation file (cardlinked-reconciliation-YYMMDD.json).

File type to return. payoutReconciliationFile and its deprecated alias monthlyReconciliationFile return the same files; type on each record echoes the name used in the filter.

page[size]integer

Number of items per page. Defaults to 10 if not specified and maximum value allowed 100 items per page.

page[after]string

Cursor for forward pagination (next page).

page[before]string

Cursor for backward pagination (previous page).

sort'sentDate' | '-sentDate'

If provided, response will be sorted by the specified fields. Defaults to descending sentDate, equivalent to "-sentDate"

Response

Response with status 200

Changes

  • bd47764afa21Revision changes
    • warning

      added the new cardlinkedReconciliationFile enum value to the // response property for the response status

    • info

      added the new enum value cardlinkedReconciliationFile to the query request parameter filter[fileType]

  • 4e87fc8b018bRevision changes
    • warning

      added the new payoutReconciliationFile enum value to the // response property for the response status

    • info

      added the new enum value payoutReconciliationFile to the query request parameter filter[fileType]

    • info

      added the non-success response with the status