> For clean Markdown of any page, append .md to the page URL.
> For a complete documentation index, see https://developers.brevo.com/llms.txt.
> For AI client integration (Claude Code, Cursor, etc.), connect to the MCP server at https://developers.brevo.com/_mcp/server.

# Create redeem voucher request

POST https://api.brevo.com/v3/loyalty/offer/programs/{pid}/rewards/redeem
Content-Type: application/json

Creates a request to redeem a voucher.

Reference: https://developers.brevo.com/reference/redeem-voucher

## Authentication

- `api-key` header (required) — The API key should be passed in the request headers as `api-key` for authentication.

## Request

### Path parameters

- `pid` (string, required) — Loyalty Program ID

### Body (application/json)

This endpoint expects an object.

- `attributedRewardId` (string, optional) — Unique identifier for the attributed reward
- `code` (string, optional) — Redemption code for the reward
- `contactId` (long, optional) — Unique identifier for the contact
- `loyaltySubscriptionId` (string, optional) — Identifier for the loyalty subscription
- `meta` (map from string to any, optional) — Additional metadata associated with the redeem request
- `order` (object, optional) — Order details for the redemption
  - `amount` (double, optional) — Total amount of the order
  - `billing` (object, optional) — Billing information for the order
    - `address` (string, optional) — Address of the user
    - `city` (string, optional) — City of the user
    - `countryCode` (string, optional) — Country code of the user
    - `paymentMethod` (string, optional) — Payment method opted by the user
    - `phone` (long, optional) — Phone number of the user
    - `postCode` (long, optional) — Postal Code of user's location
    - `region` (string, optional) — Region where user resides
  - `contact_id` (long, optional) — Unique identifier for the contact
  - `coupons` (list of string, optional) — List of coupon codes applied to the order
  - `createdAt` (datetime, optional) — Timestamp when the order was created
  - `email` (string, optional) — Email address associated with the order
  - `id` (string, optional) — Unique identifier for the order
  - `identifiers` (object, optional) — Additional identifiers for the order
    - `ext_id` (string, optional) — External identifier for the order
    - `loyalty_subscription_id` (string, optional) — Identifier for the loyalty subscription
  - `products` (list of object, optional) — List of products in the order
    - `category` (list of string, optional) — List of categories the product belongs to
    - `price` (double, optional) — Price of the product
    - `productId` (string, optional) — Unique identifier for the product
    - `quantity` (double, optional) — Quantity of the product
    - `variantId` (string, optional) — Identifier for the product variant
  - `status` (string, optional) — Current status of the order
  - `storeId` (string, optional) — Identifier for the store where the order was placed
  - `updatedAt` (datetime, optional) — Timestamp when the order was last updated
- `rewardId` (string, optional) — Unique identifier for the reward
- `ttl` (integer, optional) — Time to live in seconds for the redemption request
- `autoComplete` (boolean, optional) — Whether the redemption should be automatically completed

## Response

### 200

Redeem request successfully created

- `cancelledAt` (datetime, optional) — Timestamp when the redemption was cancelled
- `completedAt` (datetime, optional) — Timestamp when the redemption was completed
- `contactId` (long, optional) — Unique identifier for the contact
- `createdAt` (datetime, optional) — Timestamp when the redemption was created
- `debitTransactionId` (string, optional) — Unique identifier for the debit transaction
- `expiresAt` (datetime, optional) — Timestamp when the redemption expires
- `id` (string, optional) — Unique identifier for the redemption
- `loyaltyProgramId` (string, optional) — Unique identifier for the loyalty program
- `meta` (map from string to any, optional) — Additional metadata associated with the redemption
- `rejectReason` (string, optional) — Reason for rejection if the redemption was rejected
- `rejectedAt` (datetime, optional) — Timestamp when the redemption was rejected
- `rewardAttributionId` (string, optional) — Unique identifier for the reward attribution
- `status` (string, optional) — Current status of the redemption
- `updatedAt` (datetime, optional) — Timestamp when the redemption was last updated

## Errors

### 400 Bad Request Error

Bad Request

- `message` (string, required) — Readable message associated to the failure
- `code` (string, optional) — Error code displayed in case of a failure

### 401 Unauthorized Error

Request Authentication Failed

- `message` (string, required) — Readable message associated to the failure
- `code` (string, optional) — Error code displayed in case of a failure

### 403 Forbidden Error

Cannot Authenticate Request

- `message` (string, required) — Readable message associated to the failure
- `code` (string, optional) — Error code displayed in case of a failure

### 404 Not Found Error

Not Found

- `message` (string, required) — Readable message associated to the failure
- `code` (string, optional) — Error code displayed in case of a failure

### 412 Precondition Failed Error

Precondition Failed

- `message` (string, required) — Readable message associated to the failure
- `code` (string, optional) — Error code displayed in case of a failure

### 417 Expectation Failed Error

Expectation Failed

- `message` (string, required) — Readable message associated to the failure
- `code` (string, optional) — Error code displayed in case of a failure

### 422 Unprocessable Entity Error

Validation errors

- `message` (string, required) — Readable message associated to the failure
- `code` (string, optional) — Error code displayed in case of a failure

### 500 Internal Server Error

Internal error occurred

- `message` (string, required) — Readable message associated to the failure
- `code` (string, optional) — Error code displayed in case of a failure

## Examples

**Request**

```json
{}
```

**Response**

```json
{
  "cancelledAt": "2024-01-15T09:30:00Z",
  "completedAt": "2024-01-15T09:30:00Z",
  "contactId": 1,
  "createdAt": "2024-01-15T09:30:00Z",
  "debitTransactionId": "string",
  "expiresAt": "2024-01-15T09:30:00Z",
  "id": "string",
  "loyaltyProgramId": "string",
  "meta": {},
  "rejectReason": "string",
  "rejectedAt": "2024-01-15T09:30:00Z",
  "rewardAttributionId": "string",
  "status": "string",
  "updatedAt": "2024-01-15T09:30:00Z"
}
```

**SDK Code**

```typescript
import { BrevoClient } from "@getbrevo/brevo";

async function main() {
    const client = new BrevoClient({
        apiKey: "YOUR_API_KEY_HERE",
    });
    await client.reward.redeemVoucher({
        pid: "pid",
    });
}
main();

```

```python
from brevo import Brevo

client = Brevo(
    api_key="YOUR_API_KEY_HERE",
)

client.reward.redeem_voucher(
    pid="pid",
)

```

```php
<?php

namespace Example;

use Brevo\Brevo;
use Brevo\Reward\Requests\RedeemVoucherRequest;

$client = new Brevo(
    apiKey: 'YOUR_API_KEY_HERE',
);
$client->reward->redeemVoucher(
    'pid',
    new RedeemVoucherRequest([]),
);

```

```go
package main

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

func main() {

	url := "https://api.brevo.com/v3/loyalty/offer/programs/pid/rewards/redeem"

	payload := strings.NewReader("{}")

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

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

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

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

	fmt.Println(res)
	fmt.Println(string(body))

}
```

```ruby
require 'uri'
require 'net/http'

url = URI("https://api.brevo.com/v3/loyalty/offer/programs/pid/rewards/redeem")

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

request = Net::HTTP::Post.new(url)
request["api-key"] = '<apiKey>'
request["Content-Type"] = 'application/json'
request.body = "{}"

response = http.request(request)
puts response.read_body
```

```java
import com.mashape.unirest.http.HttpResponse;
import com.mashape.unirest.http.Unirest;

HttpResponse<String> response = Unirest.post("https://api.brevo.com/v3/loyalty/offer/programs/pid/rewards/redeem")
  .header("api-key", "<apiKey>")
  .header("Content-Type", "application/json")
  .body("{}")
  .asString();
```

```csharp
using RestSharp;

var client = new RestClient("https://api.brevo.com/v3/loyalty/offer/programs/pid/rewards/redeem");
var request = new RestRequest(Method.POST);
request.AddHeader("api-key", "<apiKey>");
request.AddHeader("Content-Type", "application/json");
request.AddParameter("application/json", "{}", ParameterType.RequestBody);
IRestResponse response = client.Execute(request);
```

```swift
import Foundation

let headers = [
  "api-key": "<apiKey>",
  "Content-Type": "application/json"
]
let parameters = [] as [String : Any]

let postData = JSONSerialization.data(withJSONObject: parameters, options: [])

let request = NSMutableURLRequest(url: NSURL(string: "https://api.brevo.com/v3/loyalty/offer/programs/pid/rewards/redeem")! as URL,
                                        cachePolicy: .useProtocolCachePolicy,
                                    timeoutInterval: 10.0)
request.httpMethod = "POST"
request.allHTTPHeaderFields = headers
request.httpBody = postData as Data

let session = URLSession.shared
let dataTask = session.dataTask(with: request as URLRequest, completionHandler: { (data, response, error) -> Void in
  if (error != nil) {
    print(error as Any)
  } else {
    let httpResponse = response as? HTTPURLResponse
    print(httpResponse)
  }
})

dataTask.resume()
```