> ## Documentation Index
> Fetch the complete documentation index at: https://www.marqeta.com/docs/llms.txt
> Use this file to discover all available pages before exploring further.

# Reward Accounts

> Use the `/credit/rewards/accounts/{token}` endpoint to manage reward accounts and track rewards balances, accruals, and entries on a credit account.

export const EndpointCard = ({method = "API", title, children, href, arrow = true}) => {
  const METHOD_STYLES = {
    GET: {
      bg: "mint-bg-green-400/20 dark:mint-bg-green-400/20",
      text: "mint-text-green-700 dark:mint-text-green-400",
      border: "mint-border-green-300 dark:mint-border-green-700"
    },
    POST: {
      bg: "mint-bg-blue-400/20 dark:mint-bg-blue-400/20",
      text: "mint-text-blue-700 dark:mint-text-blue-400"
    },
    PUT: {
      bg: "mint-bg-yellow-400/20 dark:mint-bg-yellow-400/20",
      text: "mint-text-yellow-700 dark:mint-text-yellow-400"
    },
    PATCH: {
      bg: "mint-bg-orange-400/20 dark:mint-bg-orange-400/20",
      text: "mint-text-orange-700 dark:mint-text-orange-400"
    },
    DELETE: {
      bg: "mint-bg-red-400/20 dark:mint-bg-red-400/20",
      text: "mint-text-red-700 dark:mint-text-red-400"
    },
    API: {
      bg: "mint-bg-black",
      text: "mint-text-white"
    }
  };
  const MethodBadge = ({method}) => {
    const style = METHOD_STYLES[method?.toUpperCase()] ?? METHOD_STYLES.GET;
    return <span className={`
          method-pill rounded-lg font-semibold px-1.5 py-0.5 text-xs leading-5 ${style.bg} ${style.text}`}>
        {method?.toUpperCase()}
      </span>;
  };
  const content = <div className="group flex items-center gap-4 border border-gray-200 dark:border-gray-700 rounded-xl p-5 hover:border-gray-400 dark:hover:border-gray-500 hover:shadow-md transition-all cursor-pointer">
      {}
      <div className="shrink-0">
        <MethodBadge method={method} />
      </div>
      {}
      <div className="flex-1 min-w-0">
        <p className="font-semibold text-gray-900 dark:text-white text-sm leading-snug">{title}</p>
        {children && <p className="mt-1 text-sm text-gray-500 dark:text-gray-400 line-clamp-2">{children}</p>}
      </div>
    </div>;
  if (!href) return content;
  return <a href={href} className="block no-underline border-b-0 mb-2">
      {content}
    </a>;
};

<Note>
  **Note**\
  This feature is currently in beta and subject to change. To learn more about the Beta program for this feature, contact your Marqeta representative.
</Note>

Use the `/credit/rewards/accounts/{token}` endpoint to manage reward accounts and track rewards balances, accruals, and entries on a credit account. The configurations for a reward account are defined in the reward policy on the account’s associated bundle. To receive webhook notifications when reward accounts and reward entry events occur, see [Credit reward entry events](/core-api/event-types/#_credit_reward_entry_events) in [Event Types](/core-api/event-types/).

<h2 id="retrieve_reward_accounts">
  List reward accounts
</h2>

**Action:** `GET`\
**Endpoint:** `/credit/rewards/accounts`

Retrieve a list of reward accounts.

<h3 id="_url_query_parameters">
  URL query parameters
</h3>

| Fields                                                       | Description                                                                                                                                                                                                                                                                                                                                                                                 |
| ------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| credit\_account\_token<br /><br />string<br /><br />Optional | Unique identifier of the credit account for which you want to retrieve reward accounts.<br /><br />**Allowable Values:**<br /><br />Existing credit account token                                                                                                                                                                                                                           |
| is\_active<br /><br />boolean<br /><br />Optional            | A value of `true` returns active resources. A value of `false` returns inactive resources.<br /><br />**Allowable Values:**<br /><br />`true`, `false`                                                                                                                                                                                                                                      |
| count<br /><br />integer<br /><br />Optional                 | Number of resources to retrieve.<br /><br />**Allowable Values:**<br /><br />1–100                                                                                                                                                                                                                                                                                                          |
| start\_index<br /><br />integer<br /><br />Optional          | Sort order index of the first resource in the returned array.<br /><br />**Allowable Values:**<br /><br />0 min                                                                                                                                                                                                                                                                             |
| sort\_by\_updated<br /><br />string<br /><br />Optional      | Field on which to sort. Prefix the field name with a hyphen (`-`) to sort in descending order. Omit the hyphen to sort in ascending order.<br /><br />**NOTE**: You must sort using system field names, such as `updatedTime`. Do not sort by field names that appear in response bodies, such as `updated_time`.<br /><br />**Allowable Values:**<br /><br />`updatedTime`, `-updatedTime` |

<h3 id="_response_body">
  Response body
</h3>

| Fields                                                                                       | Description                                                                                                                                                              |
| -------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
| count<br /><br />integer<br /><br />Returned                                                 | Number of resources returned.<br /><br />**Allowable Values:**<br /><br />1–100                                                                                          |
| start\_index<br /><br />integer<br /><br />Returned                                          | Sort order index of the first resource in the returned array.<br /><br />**Allowable Values:**<br /><br />Any integer                                                    |
| end\_index<br /><br />integer<br /><br />Returned                                            | Sort order index of the last resource in the returned array.<br /><br />**Allowable Values:**<br /><br />Any integer                                                     |
| is\_more<br /><br />boolean<br /><br />Returned                                              | A value of `true` indicates that more unreturned resources exist.<br /><br />**Allowable Values:**<br /><br />`true`, `false`                                            |
| data<br /><br />array of objects<br /><br />Returned                                         | List of reward account objects.<br /><br />**Allowable Values:**<br /><br />Valid array of one or more reward account objects                                            |
| data\[].**token**<br /><br />string<br /><br />Returned                                      | Unique identifier of the reward account.<br /><br />**Allowable Values:**<br /><br />36 char max                                                                         |
| data\[].**credit\_account\_token**<br /><br />string<br /><br />Returned                     | Unique identifier of the associated credit account.<br /><br />**Allowable Values:**<br /><br />36 char max                                                              |
| data\[].**bundle\_token**<br /><br />string<br /><br />Conditionally returned                | Unique identifier of the associated bundle that contains the reward policy on which the reward account is based.<br /><br />**Allowable Values:**<br /><br />36 char max |
| data\[].**is\_active**<br /><br />boolean<br /><br />Returned                                | A value of `true` indicates that the reward account is active.<br /><br />**Allowable Values:**<br /><br />`true`, `false`                                               |
| data\[].**global\_rules**<br /><br />array of objects<br /><br />Conditionally returned      | List of global rules.<br /><br />**Allowable Values:**<br /><br />Valid array of one or more global rules                                                                |
| data\[].global\_rules\[].**rule\_token**<br /><br />string<br /><br />Conditionally returned | Unique identifier of the rule.<br /><br />**Allowable Values:**<br /><br />36 char max                                                                                   |
| data\[].global\_rules\[].**description**<br /><br />string<br /><br />Conditionally returned | Description of the rule, pulled from the rule entry.<br /><br />**Allowable Values:**<br /><br />255 char max                                                            |
| data\[].**created\_time**<br /><br />datetime<br /><br />Returned                            | Date and time when the reward account was created on the Marqeta platform, in UTC.<br /><br />**Allowable Values:**<br /><br />Format: yyyy-MM-ddThh:mm:ssZ              |
| data\[].**updated\_time**<br /><br />datetime<br /><br />Returned                            | Date and time when the reward account was last updated on the Marqeta platform, in UTC.<br /><br />**Allowable Values:**<br /><br />Format: yyyy-MM-ddThh:mm:ssZ         |

<h3 id="_sample_response_body">
  Sample response body
</h3>

```json JSON lines wrap theme={null}
{
  "count": 1,
  "start_index": 0,
  "end_index": 0,
  "is_more": false,
  "data": [
    {
      "token": "4829608d-97e4-4a8c-bdab-20b26e7f243d",
      "credit_account_token": "bbf6c086-4286-4a1c-a3dd-2f54bf6fd799",
      "bundle_token": "f0cf97cb-76f7-47a5-83e7-188b9e741cf9",
      "is_active": true,
      "created_time": "2024-01-05T20:37:11Z",
      "updated_time": "2024-01-05T20:37:11Z"
    }
  ]
}
```

<h2 id="retrieve_reward_account">
  Retrieve reward account
</h2>

**Action:** `GET`\
**Endpoint:** `/credit/rewards/accounts/{token}`

Retrieve a specific reward account.

<h3 id="_url_path_parameters">
  URL path parameters
</h3>

| Fields                                      | Description                                                                                                        |
| ------------------------------------------- | ------------------------------------------------------------------------------------------------------------------ |
| token<br /><br />string<br /><br />Required | Unique identifier of the reward account.<br /><br />**Allowable Values:**<br /><br />Existing reward account token |

<h3 id="_url_query_parameters_2">
  URL query parameters
</h3>

| Fields                                                 | Description                                                                                                       |
| ------------------------------------------------------ | ----------------------------------------------------------------------------------------------------------------- |
| expand<br /><br />array of strings<br /><br />Optional | Embeds the specified object into the response `GLOBAL_RULES`.<br /><br />**Allowable Values:**<br /><br />`RULES` |

<h3 id="_response_body_2">
  Response body
</h3>

| Fields                                                                               | Description                                                                                                                                                              |
| ------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
| token<br /><br />string<br /><br />Returned                                          | Unique identifier of the reward account.<br /><br />**Allowable Values:**<br /><br />36 char max                                                                         |
| credit\_account\_token<br /><br />string<br /><br />Returned                         | Unique identifier of the associated credit account.<br /><br />**Allowable Values:**<br /><br />36 char max                                                              |
| bundle\_token<br /><br />string<br /><br />Conditionally returned                    | Unique identifier of the associated bundle that contains the reward policy on which the reward account is based.<br /><br />**Allowable Values:**<br /><br />36 char max |
| is\_active<br /><br />boolean<br /><br />Returned                                    | A value of `true` indicates that the reward account is active.<br /><br />**Allowable Values:**<br /><br />`true`, `false`                                               |
| global\_rules<br /><br />array of objects<br /><br />Conditionally returned          | List of global rules.<br /><br />**Allowable Values:**<br /><br />Valid array of one or more global rules                                                                |
| global\_rules\[].**rule\_token**<br /><br />string<br /><br />Conditionally returned | Unique identifier of the rule.<br /><br />**Allowable Values:**<br /><br />36 char max                                                                                   |
| global\_rules\[].**description**<br /><br />string<br /><br />Conditionally returned | Description of the rule, pulled from the rule entry.<br /><br />**Allowable Values:**<br /><br />255 char max                                                            |
| created\_time<br /><br />datetime<br /><br />Returned                                | Date and time when the reward account was created on the Marqeta platform, in UTC.<br /><br />**Allowable Values:**<br /><br />Format: yyyy-MM-ddThh:mm:ssZ              |
| updated\_time<br /><br />datetime<br /><br />Returned                                | Date and time when the reward account was last updated on the Marqeta platform, in UTC.<br /><br />**Allowable Values:**<br /><br />Format: yyyy-MM-ddThh:mm:ssZ         |

<h3 id="_sample_response_body_2">
  Sample response body
</h3>

```json JSON lines wrap theme={null}
{
  "token": "4829608d-97e4-4a8c-bdab-20b26e7f243d",
  "credit_account_token": "bbf6c086-4286-4a1c-a3dd-2f54bf6fd799",
  "bundle_token": "f0cf97cb-76f7-47a5-83e7-188b9e741cf9",
  "is_active": true,
  "global_rules": [
    {
      "rule_token": "00fb5637-2dab-4833-aa12-0463e7cf8cbb",
      "description": "Earn 3x on agricultural services, contracted services, and purchases at Target."
    }
  ],
  "created_time": "2024-01-05T20:37:11Z",
  "updated_time": "2024-01-05T20:37:11Z"
}
```

<h2 id="update_reward_account">
  Update active state
</h2>

**Action:** `PUT`\
**Endpoint:** `/credit/rewards/accounts/{token}`

Update a reward account’s active state.

<h3 id="_url_path_parameters_2">
  URL path parameters
</h3>

| Fields                                      | Description                                                                                                        |
| ------------------------------------------- | ------------------------------------------------------------------------------------------------------------------ |
| token<br /><br />string<br /><br />Required | Unique identifier of the reward account.<br /><br />**Allowable Values:**<br /><br />Existing reward account token |

<h3 id="_request_body">
  Request body
</h3>

| Fields                                            | Description                                                                                                                                                                      |
| ------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| is\_active<br /><br />boolean<br /><br />Optional | A value of `true` indicates that the reward account is active and rewards can be accrued for the associated account.<br /><br />**Allowable Values:**<br /><br />`true`, `false` |

<h3 id="_sample_request_body">
  Sample request body
</h3>

```json JSON lines wrap theme={null}
{
  "is_active": false
}
```

<h3 id="_response_body_3">
  Response body
</h3>

| Fields                                                                               | Description                                                                                                                                                              |
| ------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
| token<br /><br />string<br /><br />Returned                                          | Unique identifier of the reward account.<br /><br />**Allowable Values:**<br /><br />36 char max                                                                         |
| credit\_account\_token<br /><br />string<br /><br />Returned                         | Unique identifier of the associated credit account.<br /><br />**Allowable Values:**<br /><br />36 char max                                                              |
| bundle\_token<br /><br />string<br /><br />Conditionally returned                    | Unique identifier of the associated bundle that contains the reward policy on which the reward account is based.<br /><br />**Allowable Values:**<br /><br />36 char max |
| is\_active<br /><br />boolean<br /><br />Returned                                    | A value of `true` indicates that the reward account is active.<br /><br />**Allowable Values:**<br /><br />`true`, `false`                                               |
| global\_rules<br /><br />array of objects<br /><br />Conditionally returned          | List of global rules.<br /><br />**Allowable Values:**<br /><br />Valid array of one or more global rules                                                                |
| global\_rules\[].**rule\_token**<br /><br />string<br /><br />Conditionally returned | Unique identifier of the rule.<br /><br />**Allowable Values:**<br /><br />36 char max                                                                                   |
| global\_rules\[].**description**<br /><br />string<br /><br />Conditionally returned | Description of the rule, pulled from the rule entry.<br /><br />**Allowable Values:**<br /><br />255 char max                                                            |
| created\_time<br /><br />datetime<br /><br />Returned                                | Date and time when the reward account was created on the Marqeta platform, in UTC.<br /><br />**Allowable Values:**<br /><br />Format: yyyy-MM-ddThh:mm:ssZ              |
| updated\_time<br /><br />datetime<br /><br />Returned                                | Date and time when the reward account was last updated on the Marqeta platform, in UTC.<br /><br />**Allowable Values:**<br /><br />Format: yyyy-MM-ddThh:mm:ssZ         |

<h3 id="_sample_response_body_3">
  Sample response body
</h3>

```json JSON lines wrap theme={null}
{
  "token": "4829608d-97e4-4a8c-bdab-20b26e7f243d",
  "credit_account_token": "bbf6c086-4286-4a1c-a3dd-2f54bf6fd799",
  "bundle_token": "f0cf97cb-76f7-47a5-83e7-188b9e741cf9",
  "is_active": true,
  "created_time": "2024-01-05T20:37:11Z",
  "updated_time": "2024-01-05T20:37:11Z"
}
```

<h2 id="retrieve_reward_account_balances">
  Retrieve reward account balances
</h2>

**Action:** `GET`\
**Endpoint:** `/credit/rewards/accounts/{token}/balances`

Retrieve rewards balances for a specific reward account.

<h3 id="_url_path_parameters_3">
  URL path parameters
</h3>

| Fields                                      | Description                                                                                                        |
| ------------------------------------------- | ------------------------------------------------------------------------------------------------------------------ |
| token<br /><br />string<br /><br />Required | Unique identifier of the reward account.<br /><br />**Allowable Values:**<br /><br />Existing reward account token |

<h3 id="_url_query_parameters_3">
  URL query parameters
</h3>

| Fields                                              | Description                                                                                                                                             |
| --------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------- |
| start\_date<br /><br />datetime<br /><br />Optional | Starting date and time of a date range from which to return resources, in UTC.<br /><br />**Allowable Values:**<br /><br />format: yyyy-MM-ddThh:mm:ssZ |
| end\_date<br /><br />datetime<br /><br />Optional   | Ending date and time of a date range from which to return resources, in UTC.<br /><br />**Allowable Values:**<br /><br />format: yyyy-MM-ddThh:mm:ssZ   |

<h3 id="_response_body_4">
  Response body
</h3>

| Fields                                                                                     | Description                                                                                                                                                                                                                                                                                                                                                                                                                                      |
| ------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
| billing\_cycle\_opening\_date<br /><br />datetime<br /><br />Returned                      | Opening date of the billing cycle for which rewards were accrued, in UTC.<br /><br />**Allowable Values:**<br /><br />Format: yyyy-MM-ddThh:mm:ssZ                                                                                                                                                                                                                                                                                               |
| billing\_cycle\_closing\_date<br /><br />datetime<br /><br />Returned                      | Closing date of the billing cycle for which rewards were accrued, in UTC.<br /><br />**Allowable Values:**<br /><br />Format: yyyy-MM-ddThh:mm:ssZ                                                                                                                                                                                                                                                                                               |
| total\_spend\_this\_cycle<br /><br />decimal<br /><br />Returned                           | Total amount spent during a given billing cycle, minus any refunds or disputes, even if transactions did not result in a reward. Used to determine reward accrual.<br /><br />**Allowable Values:**<br /><br />Format: 0.00                                                                                                                                                                                                                      |
| points\_balance<br /><br />object<br /><br />Returned                                      | Pending and total accrual balance (in points) for the reward account.<br /><br />**Allowable Values:**<br /><br />`accrued_this_cycle`, `total_reward_balance`                                                                                                                                                                                                                                                                                   |
| points\_balance.**accrued\_this\_cycle**<br /><br />decimal<br /><br />Returned            | Pending balance (in points) for a reward account.<br /><br />**Allowable Values:**<br /><br />Any integer                                                                                                                                                                                                                                                                                                                                        |
| points\_balance.**total\_reward\_balance**<br /><br />decimal<br /><br />Returned          | Total reward balance (in points) for a reward account.<br /><br />**Allowable Values:**<br /><br />Any integer                                                                                                                                                                                                                                                                                                                                   |
| reward\_values<br /><br />array of objects<br /><br />Returned                             | List of possible reward conversion values.<br /><br />**Allowable Values:**<br /><br />Valid array of one or more `reward_values` objects                                                                                                                                                                                                                                                                                                        |
| reward\_values\[].**redemption\_type**<br /><br />string<br /><br />Conditionally returned | Type of redemption.<br /><br />- `EXTERNAL` - You issue the redemption on your external platform; Marqeta adjusts the reward account balance on the system of record.<br />- `STATEMENT_CREDIT` - Marqeta issues the redemption as a statement credit on the associated account.<br />**NOTE**: This creates a new journal entry on the account and cannot be undone.<br /><br />**Allowable Values:**<br /><br />`EXTERNAL`, `STATEMENT_CREDIT` |
| reward\_values\[].**conversion\_rate**<br /><br />decimal<br /><br />Returned              | Conversion rate of the reward account’s points, if they were used for this redemption type.<br /><br />**Allowable Values:**<br /><br />0.001 min<br /><br />Format: 0.000                                                                                                                                                                                                                                                                       |
| reward\_values\[].**conversion\_increment**<br /><br />decimal<br /><br />Returned         | Allowed point increments that the reward account must have to use this redemption type.<br /><br />**Allowable Values:**<br /><br />Any integer                                                                                                                                                                                                                                                                                                  |
| retrieved\_time<br /><br />datetime<br /><br />Conditionally returned                      | Retrieval date of the reward account’s accrual balance, in UTC.<br /><br />**Allowable Values:**<br /><br />Format: yyyy-MM-ddThh:mm:ssZ                                                                                                                                                                                                                                                                                                         |

<h3 id="_sample_response_body_4">
  Sample response body
</h3>

```json JSON lines wrap theme={null}
{
  "billing_cycle_opening_date": "2023-12-25T20:37:11Z",
  "billing_cycle_closing_date": "2024-01-24T20:37:11Z",
  "total_spend_this_cycle": 5832,
  "points_balance": {
    "accrued_this_cycle": 10000,
    "total_reward_balance": 25000
  },
  "reward_values": [
    {
      "redemption_type": "STATEMENT_CREDIT",
      "conversion_rate": 0.001,
      "conversion_increment": 10
    }
  ],
  "retrieved_time": "2024-01-05T20:37:11Z"
}
```

<h2 id="retrieve_reward_account_accruals">
  Retrieve reward account accruals
</h2>

**Action:** `GET`\
**Endpoint:** `/credit/rewards/accounts/{token}/accruals`

Use this endpoint to retrieve the reward accounts rewards accrual by rule for a specified time frame. If you do not specify a time frame in your query parameters, the query defaults to the current billing cycle.

<h3 id="_url_path_parameters_4">
  URL path parameters
</h3>

| Fields                                      | Description                                                                                                        |
| ------------------------------------------- | ------------------------------------------------------------------------------------------------------------------ |
| token<br /><br />string<br /><br />Required | Unique identifier of the reward account.<br /><br />**Allowable Values:**<br /><br />Existing reward account token |

<h3 id="_response_body_5">
  Response body
</h3>

| Fields                                                                                   | Description                                                                                                                                                           |
| ---------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| start\_date<br /><br />datetime<br /><br />Conditionally returned                        | Start date of rewards accrual retrieval, in UTC. Defaults to the billing cycle closing date.<br /><br />**Allowable Values:**<br /><br />Format: yyyy-MM-ddThh:mm:ssZ |
| end\_date<br /><br />datetime<br /><br />Conditionally returned                          | End date of rewards accrual retrieval, in UTC. Defaults to the billing cycle closing date.<br /><br />**Allowable Values:**<br /><br />Format: yyyy-MM-ddThh:mm:ssZ   |
| rules<br /><br />array of objects<br /><br />Conditionally returned                      | List of accrual information by rule.<br /><br />**Allowable Values:**<br /><br />Valid array of one or more rule accrual objects                                      |
| rules\[].**description**<br /><br />string<br /><br />Conditionally returned             | Description of the rule, pulled from the rule entry.<br /><br />**Allowable Values:**<br /><br />255 char max                                                         |
| rules\[].**total\_spend**<br /><br />decimal<br /><br />Conditionally returned           | Total spend contributed to the reward accrual for this rule.<br /><br />**Allowable Values:**<br /><br />Any integer                                                  |
| rules\[].**total\_rewards\_earned**<br /><br />decimal<br /><br />Conditionally returned | Total settled rewards accrued against the rule.<br /><br />**Allowable Values:**<br /><br />Any integer                                                               |
| retrieved\_time<br /><br />datetime<br /><br />Conditionally returned                    | Retrieval date of the reward account’s accruals, in UTC.<br /><br />**Allowable Values:**<br /><br />Format: yyyy-MM-ddThh:mm:ssZ                                     |

<h3 id="_sample_response_body_5">
  Sample response body
</h3>

```json JSON expandable lines wrap theme={null}
{
  "start_date": "2023-12-25T20:37:11Z",
  "end_date": "2024-01-24T20:37:11Z",
  "rules": [
    {
      "description": "Earn 3x on agricultural services, contracted services, and purchases at Target.",
      "total_spend": 12300,
      "total_rewards_earned": 30000
    },
    {
      "description": "Earn 5x on Lyft, up to $500.",
      "total_spend": 600,
      "total_rewards_earned": 2500
    },
    {
      "description": "Earn 50 points by spending $50 at Target.",
      "total_spend": 2500,
      "total_rewards_earned": 50
    },
    {
      "description": "Earn one point on all transactions.",
      "total_spend": 5863,
      "total_rewards_earned": 5000
    }
  ],
  "retrieved_time": "2024-01-05T20:37:11Z"
}
```

<h2 id="post_reward_entry">
  Create reward entry
</h2>

**Action:** `POST`\
**Endpoint:** `/credit/rewards/accounts/{token}/entries`

Create a reward entry for a specific reward account.

<h3 id="_url_path_parameters_5">
  URL path parameters
</h3>

| Fields                                      | Description                                                                                                        |
| ------------------------------------------- | ------------------------------------------------------------------------------------------------------------------ |
| token<br /><br />string<br /><br />Required | Unique identifier of the reward account.<br /><br />**Allowable Values:**<br /><br />Existing reward account token |

<h3 id="_request_body_2">
  Request body
</h3>

| Fields                                                | Description                                                                                                                                               |
| ----------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------- |
| token<br /><br />string<br /><br />Optional           | Unique identifier of the reward entry.<br /><br />**Allowable Values:**<br /><br />36 char max                                                            |
| value<br /><br />decimal<br /><br />Required          | Value of the reward granted to the account.<br /><br />**Allowable Values:**<br /><br />0.001 min<br /><br />Format: 0.000                                |
| note<br /><br />string<br /><br />Required            | Note explaining why the reward entry is being created.<br /><br />**Allowable Values:**<br /><br />255 char max                                           |
| created\_time<br /><br />datetime<br /><br />Optional | Date and time when the reward entry was created on the Marqeta platform, in UTC.<br /><br />**Allowable Values:**<br /><br />Format: yyyy-MM-ddThh:mm:ssZ |

<h3 id="_sample_request_body_2">
  Sample request body
</h3>

```json JSON lines wrap theme={null}
{
  "value": 5000,
  "note": "Account awarded 5000 bonus points for completing customer feedback survey."
}
```

<h3 id="_response_body_6">
  Response body
</h3>

| Fields                                                                             | Description                                                                                                                                                                                                   |
| ---------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| token<br /><br />string<br /><br />Returned                                        | Unique identifier of the reward entry.<br /><br />**Allowable Values:**<br /><br />36 char max                                                                                                                |
| reward\_account\_token<br /><br />string<br /><br />Returned                       | Unique identifier of the reward account for which to return reward entries.<br /><br />**Allowable Values:**<br /><br />36 char max                                                                           |
| rule\_token<br /><br />string<br /><br />Conditionally returned                    | Unique identifier of the rule used to determine the value of the reward entry.<br /><br />**Allowable Values:**<br /><br />36 char max                                                                        |
| transaction\_amount<br /><br />decimal<br /><br />Conditionally returned           | Transaction amount to which the rule was applied. Used to determine the value of the reward entry.<br /><br />**Allowable Values:**<br /><br />Format: 0.00                                                   |
| value<br /><br />decimal<br /><br />Returned                                       | Value of the reward entry.<br /><br />**Allowable Values:**<br /><br />Format: 0.00                                                                                                                           |
| related\_journal\_entry\_token<br /><br />string<br /><br />Conditionally returned | Unique identifier of the related journal entry to which the rule was applied that triggered the reward entry.<br /><br />**Allowable Values:**<br /><br />36 char max<br /><br />Existing journal entry token |
| related\_redemption\_token<br /><br />string<br /><br />Conditionally returned     | Unique identifier of the related redemption token that triggered the reward entry.<br /><br />**Allowable Values:**<br /><br />36 char max                                                                    |
| related\_entry\_token<br /><br />string<br /><br />Conditionally returned          | Unique identifier of the related reward entry token for a given dispute.<br /><br />**Allowable Values:**<br /><br />36 char max                                                                              |
| note<br /><br />string<br /><br />Returned                                         | Note providing information on the reward entry.<br /><br />**Allowable Values:**<br /><br />255 char max                                                                                                      |
| created\_time<br /><br />datetime<br /><br />Conditionally returned                | Date and time when the reward entry was created on the Marqeta platform, in UTC.<br /><br />**Allowable Values:**<br /><br />Format: yyyy-MM-ddThh:mm:ssZ                                                     |

<h3 id="_sample_response_body_6">
  Sample response body
</h3>

```json JSON lines wrap theme={null}
{
  "token": "948d82d0-2f6f-46e9-bfa2-68e0f2e1192a",
  "reward_account_token": "bb0bbc60-ba92-42c8-8556-f4b807fafb2f",
  "value": 5000,
  "note": "Account completed customer feedback survey for 5000 bonus points.",
  "created_time": "2024-01-04T20:37:11Z"
}
```

<h2 id="retrieve_reward_account_entries">
  List reward entries for a reward account
</h2>

**Action:** `GET`\
**Endpoint:** `/credit/rewards/accounts/{token}/entries`

Retrieve an array of reward entries for a specific reward account.

<h3 id="_url_path_parameters_6">
  URL path parameters
</h3>

| Fields                                      | Description                                                                                                        |
| ------------------------------------------- | ------------------------------------------------------------------------------------------------------------------ |
| token<br /><br />string<br /><br />Required | Unique identifier of the reward account.<br /><br />**Allowable Values:**<br /><br />Existing reward account token |

<h3 id="_url_query_parameters_4">
  URL query parameters
</h3>

| Fields                                                  | Description                                                                                                                                                                                                                                                                                                                                                                                 |
| ------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| start\_date<br /><br />datetime<br /><br />Optional     | Starting date and time of a date range from which to return resources, in UTC.<br /><br />**Allowable Values:**<br /><br />format: yyyy-MM-ddThh:mm:ssZ                                                                                                                                                                                                                                     |
| end\_date<br /><br />datetime<br /><br />Optional       | Ending date and time of a date range from which to return resources, in UTC.<br /><br />**Allowable Values:**<br /><br />format: yyyy-MM-ddThh:mm:ssZ                                                                                                                                                                                                                                       |
| count<br /><br />integer<br /><br />Optional            | Number of resources to retrieve.<br /><br />**Allowable Values:**<br /><br />1–100                                                                                                                                                                                                                                                                                                          |
| start\_index<br /><br />integer<br /><br />Optional     | Sort order index of the first resource in the returned array.<br /><br />**Allowable Values:**<br /><br />0 min                                                                                                                                                                                                                                                                             |
| sort\_by\_created<br /><br />string<br /><br />Optional | Field on which to sort. Prefix the field name with a hyphen (`-`) to sort in descending order. Omit the hyphen to sort in ascending order.<br /><br />**NOTE**: You must sort using system field names, such as `createdTime`. Do not sort by field names that appear in response bodies, such as `created_time`.<br /><br />**Allowable Values:**<br /><br />`createdTime`, `-createdTime` |
| status<br /><br />string<br /><br />Required            | Status of the reward entries in the returned array.<br /><br />**Allowable Values:**<br /><br />`PENDING`, `POSTED`                                                                                                                                                                                                                                                                         |

<h3 id="_response_body_7">
  Response body
</h3>

| Fields                                                                                         | Description                                                                                                                                                                                                   |
| ---------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| count<br /><br />integer<br /><br />Returned                                                   | Number of resources returned.<br /><br />**Allowable Values:**<br /><br />1–100                                                                                                                               |
| start\_index<br /><br />integer<br /><br />Returned                                            | Sort order index of the first resource in the returned array.<br /><br />**Allowable Values:**<br /><br />Any integer                                                                                         |
| end\_index<br /><br />integer<br /><br />Returned                                              | Sort order index of the last resource in the returned array.<br /><br />**Allowable Values:**<br /><br />Any integer                                                                                          |
| is\_more<br /><br />boolean<br /><br />Returned                                                | A value of `true` indicates that more unreturned resources exist.<br /><br />**Allowable Values:**<br /><br />`true`, `false`                                                                                 |
| data<br /><br />array of objects<br /><br />Returned                                           | List of reward entry objects.<br /><br />**Allowable Values:**<br /><br />Valid array of one or more reward entry objects                                                                                     |
| data\[].**token**<br /><br />string<br /><br />Returned                                        | Unique identifier of the reward entry.<br /><br />**Allowable Values:**<br /><br />36 char max                                                                                                                |
| data\[].**reward\_account\_token**<br /><br />string<br /><br />Returned                       | Unique identifier of the reward account for which to return reward entries.<br /><br />**Allowable Values:**<br /><br />36 char max                                                                           |
| data\[].**rule\_token**<br /><br />string<br /><br />Conditionally returned                    | Unique identifier of the rule used to determine the value of the reward entry.<br /><br />**Allowable Values:**<br /><br />36 char max                                                                        |
| data\[].**transaction\_amount**<br /><br />decimal<br /><br />Conditionally returned           | Transaction amount to which the rule was applied. Used to determine the value of the reward entry.<br /><br />**Allowable Values:**<br /><br />Format: 0.00                                                   |
| data\[].**value**<br /><br />decimal<br /><br />Returned                                       | Value of the reward entry.<br /><br />**Allowable Values:**<br /><br />Format: 0.00                                                                                                                           |
| data\[].**related\_journal\_entry\_token**<br /><br />string<br /><br />Conditionally returned | Unique identifier of the related journal entry to which the rule was applied that triggered the reward entry.<br /><br />**Allowable Values:**<br /><br />36 char max<br /><br />Existing journal entry token |
| data\[].**related\_redemption\_token**<br /><br />string<br /><br />Conditionally returned     | Unique identifier of the related redemption token that triggered the reward entry.<br /><br />**Allowable Values:**<br /><br />36 char max                                                                    |
| data\[].**related\_entry\_token**<br /><br />string<br /><br />Conditionally returned          | Unique identifier of the related reward entry token for a given dispute.<br /><br />**Allowable Values:**<br /><br />36 char max                                                                              |
| data\[].**note**<br /><br />string<br /><br />Returned                                         | Note providing information on the reward entry.<br /><br />**Allowable Values:**<br /><br />255 char max                                                                                                      |
| data\[].**created\_time**<br /><br />datetime<br /><br />Conditionally returned                | Date and time when the reward entry was created on the Marqeta platform, in UTC.<br /><br />**Allowable Values:**<br /><br />Format: yyyy-MM-ddThh:mm:ssZ                                                     |

<h3 id="_sample_response_body_7">
  Sample response body
</h3>

```json JSON expandable lines wrap theme={null}
{
  "count": 5,
  "start_index": 0,
  "end_index": 0,
  "is_more": false,
  "data": [
    {
      "token": "12959312-675e-44e9-b6be-9dc7a0d996bd",
      "reward_account_token": "bb0bbc60-ba92-42c8-8556-f4b807fafb2f",
      "rule_token": "b125a2ea-477d-410f-b6a1-283b8eddb3cd",
      "transaction_amount": 100,
      "value": 200,
      "note": "Account awarded 5000 bonus points for completing customer feedback survey.",
      "related_journal_entry_token": "64794ba4-9094-466f-b11a-b3d1daf17293",
      "created_time": "2024-01-01T20:37:11Z"
    },
    {
      "token": "12959312-675e-44e9-b6be-9dc7a0d996bd",
      "reward_account_token": "bb0bbc60-ba92-42c8-8556-f4b807fafb2f",
      "rule_token": "b125a2ea-477d-410f-b6a1-283b8eddb3cd",
      "transaction_amount": 500,
      "value": 50,
      "note": "Account awarded 5000 bonus points for completing customer feedback survey.",
      "related_journal_entry_token": "64794ba4-9094-466f-b11a-b3d1daf17293",
      "related_redemption_token": "fd3efc80-bd54-49bd-acae-0e2dd96ccc01",
      "created_time": "2024-01-02T20:37:11Z"
    },
    {
      "token": "4391dd08-b91f-47be-8577-dc080d4e51a5",
      "reward_account_token": "bb0bbc60-ba92-42c8-8556-f4b807fafb2f",
      "rule_token": "5fd9cb86-1ecf-4eb9-beea-db308b051797",
      "value": 200,
      "note": "Account awarded 5000 bonus points for completing customer feedback survey.",
      "created_time": "2024-01-03T20:37:11Z"
    },
    {
      "token": "4d0ff4ee-ee97-48a8-9494-70edcf456aab",
      "reward_account_token": "bb0bbc60-ba92-42c8-8556-f4b807fafb2f",
      "value": 20000,
      "related_journal_entry_token": "64794ba4-9094-466f-b11a-b3d1daf17293",
      "related_redemption_token": "fd3efc80-bd54-49bd-acae-0e2dd96ccc01",
      "note": "Customer called in, one time reward for error in statement.",
      "created_time": "2024-01-04T20:37:11Z"
    },
    {
      "token": "1417c942-2eba-4238-ac44-d04db1f411cd",
      "reward_account_token": "bb0bbc60-ba92-42c8-8556-f4b807fafb2f",
      "value": -1000,
      "note": "Account awarded 5000 bonus points for completing customer feedback survey.",
      "related_redemption_token": "fd3efc80-bd54-49bd-acae-0e2dd96ccc01",
      "created_time": "2024-01-04T20:37:11Z"
    }
  ]
}
```

<h2 id="retrieve_reward_entry">
  Retrieve reward entry
</h2>

**Action:** `GET`\
**Endpoint:** `/credit/rewards/accounts/{token}/entries/{entry_token}`

Retrieve a specific reward entry for a reward account.

<h3 id="_url_path_parameters_7">
  URL path parameters
</h3>

| Fields                                             | Description                                                                                                        |
| -------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------ |
| entry\_token<br /><br />string<br /><br />Required | Unique identifier of the reward entry to retrieve.<br /><br />**Allowable Values:**<br /><br />36 char max         |
| token<br /><br />string<br /><br />Required        | Unique identifier of the reward account.<br /><br />**Allowable Values:**<br /><br />Existing reward account token |

<h3 id="_response_body_8">
  Response body
</h3>

| Fields                                                                             | Description                                                                                                                                                                                                   |
| ---------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| token<br /><br />string<br /><br />Returned                                        | Unique identifier of the reward entry.<br /><br />**Allowable Values:**<br /><br />36 char max                                                                                                                |
| reward\_account\_token<br /><br />string<br /><br />Returned                       | Unique identifier of the reward account for which to return reward entries.<br /><br />**Allowable Values:**<br /><br />36 char max                                                                           |
| rule\_token<br /><br />string<br /><br />Conditionally returned                    | Unique identifier of the rule used to determine the value of the reward entry.<br /><br />**Allowable Values:**<br /><br />36 char max                                                                        |
| transaction\_amount<br /><br />decimal<br /><br />Conditionally returned           | Transaction amount to which the rule was applied. Used to determine the value of the reward entry.<br /><br />**Allowable Values:**<br /><br />Format: 0.00                                                   |
| value<br /><br />decimal<br /><br />Returned                                       | Value of the reward entry.<br /><br />**Allowable Values:**<br /><br />Format: 0.00                                                                                                                           |
| related\_journal\_entry\_token<br /><br />string<br /><br />Conditionally returned | Unique identifier of the related journal entry to which the rule was applied that triggered the reward entry.<br /><br />**Allowable Values:**<br /><br />36 char max<br /><br />Existing journal entry token |
| related\_redemption\_token<br /><br />string<br /><br />Conditionally returned     | Unique identifier of the related redemption token that triggered the reward entry.<br /><br />**Allowable Values:**<br /><br />36 char max                                                                    |
| related\_entry\_token<br /><br />string<br /><br />Conditionally returned          | Unique identifier of the related reward entry token for a given dispute.<br /><br />**Allowable Values:**<br /><br />36 char max                                                                              |
| note<br /><br />string<br /><br />Returned                                         | Note providing information on the reward entry.<br /><br />**Allowable Values:**<br /><br />255 char max                                                                                                      |
| created\_time<br /><br />datetime<br /><br />Conditionally returned                | Date and time when the reward entry was created on the Marqeta platform, in UTC.<br /><br />**Allowable Values:**<br /><br />Format: yyyy-MM-ddThh:mm:ssZ                                                     |

<h3 id="_sample_response_body_8">
  Sample response body
</h3>

```json JSON lines wrap theme={null}
{
  "token": "1417c942-2eba-4238-ac44-d04db1f411cd",
  "reward_account_token": "bb0bbc60-ba92-42c8-8556-f4b807fafb2f",
  "value": -1000,
  "note": "Account completed customer feedback survey for 5000 bonus points.",
  "related_redemption_token": "fd3efc80-bd54-49bd-acae-0e2dd96ccc01",
  "created_time": "2024-01-04T20:37:11Z"
}
```


## Related topics

- [Account Rewards](/docs/core-api/credit-account-rewards.md)
- [About Reward Accounts](/docs/developer-guides/about-credit-reward-accounts.md)
- [Credit Overview](/docs/developer-guides/credit-landing-page.md)
- [About Credit Accounts](/docs/developer-guides/about-credit-accounts.md)
- [Platform Overview](/docs/developer-guides/platform-overview.md)
