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

# Get Reward Transaction

> Endpoint to retrieve information regarding a reward transaction

> [!NOTE]
>
> The `x-api-key` header value to be used on this API is your **partner API key**, which can be generated through the dashboard.

**id** `string` *required*

Unique identifier of the reward transaction to retrieve (UUID)

### Return values

**reward\_transaction** `object`

A reward\_transaction object property

**properties**

**id** `integer`

Benji Platform reward transaction identifier

**partner\_id** `integer`

The ID of the partner associated with this transaction in the Benji Platform

**partnership\_uuid** `string`

The UUID of the partnership associated with this transaction in the Benji Platform

**campaign\_id** `integer`

The ID of the campaign triggered for this transaction in the Benji Platform

**user\_uuid** `string`

The UUID of the user associated with the transaction in the Benji Platform

**trigger\_event\_uuid\_id** `string`

The UUID of the trigger event associated with the transaction in the Benji Platform

**trigger\_event\_id** `integer`

The ID of the trigger event associated with the transaction in the Benji Platform

**merchant\_id** `integer`

The ID of the merchant partner associated with this campaign in the Benji Platform

**transaction\_amount** `integer`

The total dollar amount of the transaction

**reward\_amount** `integer`

The total amount of rewards earned or redeemed on this transaction

**external\_order\_id** `string`

The external reference of the order on the merchant partner system

**transaction\_type** `integer`

Integer representing an enum of one of the following transaction type values:

**possible transaction type values**

* **EARN (1)** : Indicating an earn transaction type \\

* **REDEEM (2)** : Indicating a redeem transaction type  \\

**transaction\_status** `integer`

Integer representing an enum of one of the following transaction status values:

**possible transaction status values**

* **INITIATED (1)** : Transaction has been initiated \\

* **PENDING (2)** : Transaction is pending and has not been confirmed by the partner yet \\

* **COMPLETED (3)** : Transaction has been completed successfully \\

* **ERROR (4)** : An error occurred during processing \\

* **REVERSED (5)** : Transaction was reversed \\

* **FAILED (6)** : Transaction was rejected by the partner \\

* **CANCELLED (7)** : Transaction was cancelled \\

**created\_date** `datetime`

The transaction date

```json 200 theme={null}
{
    "code": "ok",
    "data": {
        "reward_transaction": {
            "campaign_id": "675976-khkgyt7-9876-khfiy",
            "created_date": "2025-08-18T20:45:01.186277+00:00",
            "external_id": null,
            "external_order_id": null,
            "external_partner_transaction_id": null,
            "id": 5924,
            "merchant_id": 41,
            "partner_id": 5,
            "partnership_uuid": "partnership-uuid",
            "trigger_event_uuid_id": "trigger-event-uuid",
            "trigger_event_id": 12345,
            "reward_amount": 600,
            "transaction_amount": 0.0,
            "transaction_status": 4,
            "transaction_type": 1,
            "user_uuid": "user-uuid"
        }
    }
}
```

```json 400 theme={null}
{
  "code": "invalid_token",
  "message": "Invalid token"
}
```

```json 401 theme={null}
{
  "code": "unauthorized_request",
  "message": "Token is not authorized to make this request"
}
```

```json 404 theme={null}
{
  "code": "transaction_does_not_exist",
  "message": "The transaction does not exist"
}
```

> [!TIP]
>
> Note that you will only receive data that you as a loyalty partner or merchant partner are allowed to see based on the permissions in the access token you provide to the API.


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.