Create Reward
Creating a reward account for a new user
POST {{BASE_URL}} /v1/rewards/create
Parameters
Parameter
Type
Description
Required
RequestReference
string
A unique reference for this specific API call.
True
RequestType
string
This will be either Live (for real Transaction) or Sandbox (for testing purpose)
True
Amount
decimal
The Value of cash reward or Point Reward
True
RewardType
string
This will be either Cash or Point
True
Description
string
Reward description
True
FirstName
string
Customer first name
True
LastName
string
Customer last name
True
string
Customer email address
True
Reference
string
Unique Customer Identifier (this will be used for getting customers details)
True
PhoneNumber
string
Customers phone number
True
Request
{
'Authorization': 'Bearer dcf9e6f376c422d3ca925457b7927793a6d1713034426ccf2c07ae956e39',
'Content-Type': 'application/json',
}{
"RequestReference": "REQ-12345",
"RequestType": "Sandbox",
"Data": {
"Amount": 132.00,
"RewardType": "Cash",
"Description": "Reward for excellent service",
"Customer": {
"FirstName": "Joseph",
"LastName": "Ebenezer",
"Email": "[email protected]",
"Reference": "dab6e96d-a195-42b4-a745-79f8ee3c19e6",
"PhoneNumber": "+2349021234556"
}
}
}{
"status": "Successful",
"message": "Reward Transaction completed successfully",
"data": {
"reference": "416169963037",
"date": "2024-10-23",
"amount": 132.00,
"customer": {
"firstName": "Joseph",
"lastName": "Ebenezer",
"email": "[email protected]",
"reference": "gre588-5a48-450f-ab48-f2ba8724feb2",
"poggahCustomerRef": "PGC-44323702111",
"phoneNumber": "+2349051575213"
},
"rewardDetails": {
"rewardType": "Cash",
"amount": 132.00,
"cashBalance": 154.00,
"pointBalance": 327
}
}
}Last updated