Skip to main content
POST
/
customer
/
api
/
open
/
v1
/
loyalty
/
customers
/
{customerId}
/
redeem
Redeem reward and create voucher
curl --request POST \
  --url https://api.bitbybit.studio/customer/api/open/v1/loyalty/customers/{customerId}/redeem \
  --header 'Content-Type: application/json' \
  --header 'x-api-key: <api-key>' \
  --data '
{
  "rewardOptionId": "<string>",
  "rewardName": "<string>",
  "pointsCost": 2,
  "voucherCode": "<string>",
  "voucherProvider": "<string>",
  "voucherExternalId": "<string>",
  "idempotencyKey": "<string>",
  "metadata": {}
}
'
import requests

url = "https://api.bitbybit.studio/customer/api/open/v1/loyalty/customers/{customerId}/redeem"

payload = {
"rewardOptionId": "<string>",
"rewardName": "<string>",
"pointsCost": 2,
"voucherCode": "<string>",
"voucherProvider": "<string>",
"voucherExternalId": "<string>",
"idempotencyKey": "<string>",
"metadata": {}
}
headers = {
"x-api-key": "<api-key>",
"Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)
const options = {
method: 'POST',
headers: {'x-api-key': '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({
rewardOptionId: '<string>',
rewardName: '<string>',
pointsCost: 2,
voucherCode: '<string>',
voucherProvider: '<string>',
voucherExternalId: '<string>',
idempotencyKey: '<string>',
metadata: {}
})
};

fetch('https://api.bitbybit.studio/customer/api/open/v1/loyalty/customers/{customerId}/redeem', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));
<?php

$curl = curl_init();

curl_setopt_array($curl, [
CURLOPT_URL => "https://api.bitbybit.studio/customer/api/open/v1/loyalty/customers/{customerId}/redeem",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'rewardOptionId' => '<string>',
'rewardName' => '<string>',
'pointsCost' => 2,
'voucherCode' => '<string>',
'voucherProvider' => '<string>',
'voucherExternalId' => '<string>',
'idempotencyKey' => '<string>',
'metadata' => [

]
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json",
"x-api-key: <api-key>"
],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}
package main

import (
"fmt"
"strings"
"net/http"
"io"
)

func main() {

url := "https://api.bitbybit.studio/customer/api/open/v1/loyalty/customers/{customerId}/redeem"

payload := strings.NewReader("{\n \"rewardOptionId\": \"<string>\",\n \"rewardName\": \"<string>\",\n \"pointsCost\": 2,\n \"voucherCode\": \"<string>\",\n \"voucherProvider\": \"<string>\",\n \"voucherExternalId\": \"<string>\",\n \"idempotencyKey\": \"<string>\",\n \"metadata\": {}\n}")

req, _ := http.NewRequest("POST", url, payload)

req.Header.Add("x-api-key", "<api-key>")
req.Header.Add("Content-Type", "application/json")

res, _ := http.DefaultClient.Do(req)

defer res.Body.Close()
body, _ := io.ReadAll(res.Body)

fmt.Println(string(body))

}
HttpResponse<String> response = Unirest.post("https://api.bitbybit.studio/customer/api/open/v1/loyalty/customers/{customerId}/redeem")
.header("x-api-key", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"rewardOptionId\": \"<string>\",\n \"rewardName\": \"<string>\",\n \"pointsCost\": 2,\n \"voucherCode\": \"<string>\",\n \"voucherProvider\": \"<string>\",\n \"voucherExternalId\": \"<string>\",\n \"idempotencyKey\": \"<string>\",\n \"metadata\": {}\n}")
.asString();
require 'uri'
require 'net/http'

url = URI("https://api.bitbybit.studio/customer/api/open/v1/loyalty/customers/{customerId}/redeem")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["x-api-key"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"rewardOptionId\": \"<string>\",\n \"rewardName\": \"<string>\",\n \"pointsCost\": 2,\n \"voucherCode\": \"<string>\",\n \"voucherProvider\": \"<string>\",\n \"voucherExternalId\": \"<string>\",\n \"idempotencyKey\": \"<string>\",\n \"metadata\": {}\n}"

response = http.request(request)
puts response.read_body
{
  "data": {
    "wallet": {
      "id": "<string>",
      "companyId": 123,
      "customerId": "<string>",
      "availablePoints": "<string>",
      "reservedPoints": "<string>",
      "lifetimeEarnedPoints": "<string>",
      "lifetimeBurnedPoints": "<string>",
      "version": "<string>",
      "lastLedgerAt": "2023-11-07T05:31:56Z",
      "createdAt": "2023-11-07T05:31:56Z",
      "updatedAt": "2023-11-07T05:31:56Z"
    },
    "redemption": {
      "id": "<string>",
      "companyId": 123,
      "customerId": "<string>",
      "customer": {
        "id": "<string>",
        "companyId": 123,
        "name": "<string>",
        "email": "<string>",
        "phoneNumber": "<string>"
      },
      "walletId": "<string>",
      "rewardOptionId": "<string>",
      "rewardName": "<string>",
      "status": "<string>",
      "pointsReserved": "<string>",
      "pointsCommitted": "<string>",
      "voucherCode": "<string>",
      "voucherProvider": "<string>",
      "voucherExternalId": "<string>",
      "reserveExpiresAt": "2023-11-07T05:31:56Z",
      "commitAt": "2023-11-07T05:31:56Z",
      "releasedAt": "2023-11-07T05:31:56Z",
      "failureReason": "<string>",
      "idempotencyKey": "<string>",
      "metadata": {},
      "createdById": 123,
      "createdAt": "2023-11-07T05:31:56Z",
      "updatedAt": "2023-11-07T05:31:56Z"
    },
    "ledger": {
      "id": "<string>",
      "companyId": 123,
      "customerId": "<string>",
      "walletId": "<string>",
      "entryType": "<string>",
      "pointsDelta": "<string>",
      "availableAfter": "<string>",
      "reservedAfter": "<string>",
      "referenceType": "<string>",
      "referenceId": "<string>",
      "idempotencyKey": "<string>",
      "note": "<string>",
      "metadata": {},
      "occurredAt": "2023-11-07T05:31:56Z",
      "createdAt": "2023-11-07T05:31:56Z",
      "createdById": 123
    },
    "idempotencyKey": "<string>"
  }
}

Authorizations

x-api-key
string
header
required

API key for authentication. Create one in Settings > Developer.

Path Parameters

customerId
string
required

Body

application/json
rewardOptionId
string
required
rewardName
string
required
pointsCost
integer
required
Required range: x >= 1
voucherCode
string
voucherProvider
string
voucherExternalId
string
idempotencyKey
string
metadata
object

Response

200 - application/json

Success

data
object