API Documentation
Member API
Reward API
Partnerships
Webhooks
Get Reward Transaction
Copy
Ask AI
curl --request GET \
--url https://api-staging.withbenji.com/transactions/{id} \
--header 'x-api-key: <api-key>'Copy
Ask AI
{
"code": "ok",
"data": {
"reward_transaction": {
"created_date": "2024-08-23T19:55:12.015047+00:00",
"last_updated_date": "2024-08-23T19:57:12.015047+00:00",
"status": 2,
"external_order_id": "5856681787572",
"id": 1,
"merchant_id": 1,
"partner_id": 1,
"campaign_id": 1,
"reward_amount": 266,
"transaction_amount": 885.95,
"transaction_type": 1,
"user_id": 1
}
}
}
Reward API
Get Reward Transaction
Endpoint to retrieve information regarding a reward transaction
GET
https://api-staging.withbenji.com
/
transactions
/
{id}
Get Reward Transaction
Copy
Ask AI
curl --request GET \
--url https://api-staging.withbenji.com/transactions/{id} \
--header 'x-api-key: <api-key>'Copy
Ask AI
{
"code": "ok",
"data": {
"reward_transaction": {
"created_date": "2024-08-23T19:55:12.015047+00:00",
"last_updated_date": "2024-08-23T19:57:12.015047+00:00",
"status": 2,
"external_order_id": "5856681787572",
"id": 1,
"merchant_id": 1,
"partner_id": 1,
"campaign_id": 1,
"reward_amount": 266,
"transaction_amount": 885.95,
"transaction_type": 1,
"user_id": 1
}
}
}
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 ID of the campaign triggered for this transaction in the Benji Platform
The ID of the user associated with the transaction in the Benji Platform
The ID of the merchant partner associated with this campaign in the Benji Platform
The total amount of dollars 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 campaign 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 values :
Show possible transaction status values
Show possible transaction status values
- PENDING (1) : Indicating a transaction that is pending and has not been confirmed by the partner yet
- CONFIRMED (2) : Indicating a transaction that has been confirmed by the partner
- FAILED (3) : Indicating a transaction that has been rejected by the partner
If status is FAILED, the reason why this transaction was rejected
Datetime indicating the last status change.For instance, is the status is CONFIRMED, this date will indicate when the transaction was confirmed
The transaction date
Copy
Ask AI
{
"code": "ok",
"data": {
"reward_transaction": {
"created_date": "2024-08-23T19:55:12.015047+00:00",
"last_updated_date": "2024-08-23T19:57:12.015047+00:00",
"status": 2,
"external_order_id": "5856681787572",
"id": 1,
"merchant_id": 1,
"partner_id": 1,
"campaign_id": 1,
"reward_amount": 266,
"transaction_amount": 885.95,
"transaction_type": 1,
"user_id": 1
}
}
}
Note that you will only receive data that you as a loyalty patner 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