Credit Rewards

Use this view endpoint to retrieve rewards data for credit accounts in a program in either a detailed or monthly view. The data is derived from the balance-related activity on the Marqeta platform. This endpoint supports multiple response formats, query filtering, field filtering, sorting, pagination, and currency conversion. For more information about response options, see Response Customization.

Retrieve rewards detail (JSON)

Action: GET
Endpoint: /views/credit/rewards/detail Retrieve rewards detail for the credit accounts in a program. This endpoint returns a JSON object that contains an array of records matching your filter query.

Sample response body

The following sample shows a representative response for a GET request to the /views/credit/rewards/detail?program=my_program&fields=currency_code,amount,updated_time endpoint.

JSON

{
  "total": 0,
  "is_more": false,
  "count": 0,
  "info": {},
  "start_date": null,
  "end_date": null,
  "last_run_time": "",
  "schema": [
    {
      "field": "currency_code",
      "type": "TEXT",
      "scale": null,
      "character_maximum_length": 3.0,
      "description": "The three-number code of the currency.",
      "display": "Currency Code",
      "units": null,
      "has_total": false,
      "is_filter_only": false
    },
    {
      "field": "amount",
      "type": "NUMBER",
      "scale": 2.0,
      "character_maximum_length": null,
      "description": "#N/A",
      "display": "Amount",
      "units": null,
      "has_total": true,
      "is_filter_only": false
    },
    {
      "field": "updated_time",
      "type": "TIMESTAMP_NTZ",
      "scale": null,
      "character_maximum_length": null,
      "description": null,
      "display": "Updated Time",
      "units": null,
      "has_total": false,
      "date_format": "YYYY-MM-DD HH:mm:ss",
      "is_filter_only": false
    }
  ]
  "records": [
    {
      "currency_code": "USD",
      "amount": 50.0,
      "updated_time": "2021-05-05T00:00:00+0000"
    },
    {
      "currency_code": "USD",
      "amount": 40.0,
      "updated_time": "2021-05-05T00:00:00+0000"
    },

    ...

    {
      "currency_code": "USD",
      "type": 25.0,
      "updated_time": "2021-05-05T00:00:00+0000"
    }
  ]
}

Retrieve rewards detail (file export)

Action: GET
Endpoint: /views/credit/rewards/detail/{export_type} Retrieve credit rewards detail for the credit accounts in a program and export to a file. This endpoint asynchronously generates a file in the specified format and returns a job token for retrieving the file when it is completed. The file contains a list of records matching your filter query.

URL path parameters

Fields	Description
export_type string Required	File format in which to export the data. Allowable Values: csv

Query parameters

Fields	Description
compress string optional	Type of file compression for the exported file. Allowable Values: gz, zip Default value: gz

Sample response body

JSON

{
    "token": "111122226c444d8888888a9999ae11111db63da4.csv.gz"
}

Retrieve schema for rewards detail

Action: GET
Endpoint: /views/credit/rewards/detail/schema Retrieve a JSON representation of the credit rewards detail view schema. The schema object contains an array of objects that describe the available columns and the data type of each column.

Sample response body

The following sample shows a representative response for a GET request to the /views/credit/rewards/detail/schema?program=my_program endpoint. The schema can vary based on the data you are authorized to access (based on the credentials you provide in your request).

JSON

[
    {
        "field": "token",
        "type": "character varying(36)",
        "display": "Token",
        "description": "#N/A",
        "units": null,
        "has_total": false,
        "is_filter_only": false
    },
    {
        "field": "account_token",
        "type": "character varying(36)",
        "display": "Account Token",
        "description": null,
        "units": null,
        "has_total": false,
        "is_filter_only": false
    },
    {
        "field": "type",
        "type": "character varying(128)",
        "display": "Type",
        "description": null,
        "units": null,
        "has_total": false,
        "is_filter_only": false
    },
    {
        "field": "description",
        "type": "character varying(255)",
        "display": "Description",
        "description": null,
        "units": null,
        "has_total": false,
        "is_filter_only": false
    },
    {
        "field": "currency_code",
        "type": "character varying(3)",
        "display": "Currency Code",
        "description": "The three-number code of the currency.",
        "units": null,
        "has_total": false,
        "is_filter_only": false
    },
    {
        "field": "amount",
        "type": "numeric(14,2)",
        "display": "Amount",
        "description": "#N/A",
        "units": "USD",
        "has_total": true,
        "is_filter_only": false
    },
    {
        "field": "note",
        "type": "character varying(255)",
        "display": "Note",
        "description": null,
        "units": null,
        "has_total": false,
        "is_filter_only": false
    },
    {
        "field": "updated_time",
        "type": "timestamp without time zone",
        "display": "Updated Time",
        "description": null,
        "date_format": "YYYY-MM-DD HH:mm:ss",
        "units": null,
        "has_total": false,
        "is_filter_only": false
    },
    {
        "field": "created_time",
        "type": "timestamp without time zone",
        "display": "Created Time",
        "description": "The time the ACH verification was created.",
        "date_format": "YYYY-MM-DD HH:mm:ss",
        "units": null,
        "has_total": false,
        "is_filter_only": false
    },
    {
        "field": "report_load_timestamp",
        "type": "timestamp without time zone",
        "display": "Report Load Timestamp",
        "description": "UTC time when the record was loaded into Marqeta's reporting system",
        "date_format": "YYYY-MM-DD",
        "units": null,
        "has_total": false,
        "is_filter_only": false
    }
]

Retrieve rewards by month (JSON)

Action: GET
Endpoint: /views/credit/rewards/month Retrieve a sum of all credit account rewards for a given month grouped by account token. This endpoint returns a JSON object that contains an array of records matching your filter query.

Sample response body

The following sample shows a representative response for a GET request to the /views/credit/rewards/month?program=my_program endpoint.

JSON

{
  "total": 0,
  "is_more": false,
  "count": 0,
  "info": {},
  "start_date": null,
  "end_date": null,
  "last_run_time": "",
  "schema": [
    {
      "field": "account_token",
      "type": "TEXT",
      "scale": null,
      "character_maximum_length": 36.0,
      "description": null,
      "display": "Account Token",
      "units": null,
      "has_total": false,
      "is_filter_only": false
    },
    {
      "field": "total_amount",
      "type": "NUMBER",
      "scale": 2.0,
      "character_maximum_length": null,
      "description": null,
      "display": "Total Amount",
      "units": null,
      "has_total": false,
      "is_filter_only": false
    },
    {
      "field": "month_key",
      "type": "DATE",
      "scale": null,
      "character_maximum_length": null,
      "description": null,
      "display": "Month Key",
      "units": null,
      "has_total": false,
      "date_format": "YYYY-MM",
      "is_filter_only": false
    }
  ],
  "records": [
    {
      "account_token": "<account_token>",
      "total_amount": 50.0,
      "month_key": "2021-05"
    },
    {
      "account_token": "<account_token>",
      "total_amount": 40.0,
      "month_key": "2021-05"
    },

    ...

    {
      "account_token": "<account_token>",
      "total_amount": 25.0,
      "updated_time": "2021-05"
    }
  ]
}

Retrieve rewards by month (file export)

Action: GET
Endpoint: /views/credit/rewards/month/{export_type} Retrieve rewards by month for the credit accounts in a program and export to a file. This endpoint asynchronously generates a file in the specified format and returns a job token for retrieving the file when it is completed. The file contains a list of records matching your filter query.

URL path parameters

Fields	Description
export_type string Required	File format in which to export the data. Allowable Values: csv

Query parameters

Fields	Description
compress string optional	Type of file compression for the exported file. Allowable Values: gz, zip Default value: gz

Sample response body

JSON

{
  "token": "111122226c444d8888888a9999ae11111db63da4.csv.gz"
}

Retrieve schema for rewards by month

Action: GET
Endpoint: /views/credit/rewards/month/schema Retrieve a JSON representation of the credit rewards by month view schema. The schema object contains an array of objects that describe the available columns and the data type of each column.

Sample response body

The following sample shows a representative response for a GET request to the /views/credit/rewards/month/schema?program=my_program endpoint. The schema can vary based on the data you are authorized to access (based on the credentials you provide in your request).

JSON

[
    {
        "field": "account_token",
        "type": "character varying(36)",
        "display": "Account Token",
        "description": null,
        "units": null,
        "has_total": false,
        "is_filter_only": false
    },
    {
        "field": "total_amount",
        "type": "numeric(14,2)",
        "display": "Total Amount",
        "description": null,
        "units": null,
        "has_total": false,
        "is_filter_only": false
    },
    {
        "field": "month_key",
        "type": "date",
        "display": "Month Key",
        "description": null,
        "date_format": "YYYY-MM",
        "units": null,
        "has_total": false,
        "is_filter_only": false
    },
    {
        "field": "report_load_timestamp",
        "type": "timestamp without time zone",
        "display": "Report Load Timestamp",
        "description": "UTC time when the record was loaded into Marqeta's reporting system",
        "date_format": "YYYY-MM-DD",
        "units": null,
        "has_total": false,
        "is_filter_only": false
    }
]

​Retrieve rewards detail (JSON)

​Sample response body

​Retrieve rewards detail (file export)

​URL path parameters

​Query parameters

​Sample response body

​Retrieve schema for rewards detail

​Sample response body

​Retrieve rewards by month (JSON)

​Sample response body

​Retrieve rewards by month (file export)

​URL path parameters

​Query parameters

​Sample response body

​Retrieve schema for rewards by month

​Sample response body

Retrieve rewards detail (JSON)

Sample response body

Retrieve rewards detail (file export)

URL path parameters

Query parameters

Sample response body

Retrieve schema for rewards detail

Sample response body

Retrieve rewards by month (JSON)

Sample response body

Retrieve rewards by month (file export)

URL path parameters

Query parameters

Sample response body

Retrieve schema for rewards by month

Sample response body