API Documentation
Tokens
Member API
- Users
Campaign API
- Campaigns
- Triggers
Reward API
- Transactions
Webhooks
Create a transaction
Create a transaction using the reward transaction authentication token from the previous step.
POST
/
reward_transaction
/
create
curl --request POST \
--url https://rewardservice.withbenji.com/reward_transaction/create \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '{
"reward_authentication_token": "<string>"
}'{
"code": "ok",
"data": {
"reward_transactions": [{
"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 Bearer token to be used on this API is a user based access token
The token received from the authenticate reward transaction API call.
Return values
An array of reward transaction objects created with this transaction
A reward transaction object property
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 :
- 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 :
- 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
{
"code": "ok",
"data": {
"reward_transactions": [{
"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
}]
}
}
Make sure to store the returned reward transaction ID. You can use this ID to get the status of the reward transaction when receiving reward_transaction_update webhooks
The transaction authentication token is valid for 10 minutes.
Was this page helpful?
curl --request POST \
--url https://rewardservice.withbenji.com/reward_transaction/create \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '{
"reward_authentication_token": "<string>"
}'{
"code": "ok",
"data": {
"reward_transactions": [{
"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
}]
}
}