Get Reward Transaction
curl --request GET \
--url https://api-staging.withbenji.com/transactions/{id} \
--header 'x-api-key: <api-key>'{
"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"
}
}
}
Reward API
Get Reward Transaction
Endpoint to retrieve information regarding a reward transaction
GET
/
transactions
/
{id}
Get Reward Transaction
curl --request GET \
--url https://api-staging.withbenji.com/transactions/{id} \
--header 'x-api-key: <api-key>'{
"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"
}
}
}
The
x-api-key header value to be used on this API is your partner API key, which can be generated through the dashboard.Unique identifier of the reward transaction to retrieve (UUID)
Return values
A reward_transaction object property
Hide properties
Hide properties
Benji Platform reward transaction identifier
The ID of the partner associated with this transaction in the Benji Platform
The UUID of the partnership associated with this transaction in the Benji Platform
The ID of the campaign triggered for this transaction in the Benji Platform
The UUID of the user associated with the transaction in the Benji Platform
The UUID of the trigger event associated with the transaction in the Benji Platform
The ID of the trigger event associated with the transaction in the Benji Platform
The ID of the merchant partner associated with this campaign in the Benji Platform
The total dollar amount of the transaction
The total amount of rewards earned or redeemed on this transaction
The external reference of the order on the merchant partner system
Integer representing an enum of one of the following transaction type values:
Show possible transaction type values
Show possible transaction type values
- EARN (1) : Indicating an earn transaction type
- REDEEM (2) : Indicating a redeem transaction type
Integer representing an enum of one of the following transaction status values:
Show possible transaction status values
Show 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
The transaction date
{
"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"
}
}
}
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.
Was this page helpful?
⌘I