Criar um cupom
curl --request POST \
--url https://api.abacatepay.com/v2/coupons/create \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"code": "DEYVIN_20",
"maxRedeems": 10,
"discount": 1000,
"notes": "Cupom de desconto pro meu público",
"startsAt": "2026-09-01T00:00:00.000Z",
"expiresAt": "2026-12-31T23:59:59.000Z"
}
'import requests
url = "https://api.abacatepay.com/v2/coupons/create"
payload = {
"code": "DEYVIN_20",
"maxRedeems": 10,
"discount": 1000,
"notes": "Cupom de desconto pro meu público",
"startsAt": "2026-09-01T00:00:00.000Z",
"expiresAt": "2026-12-31T23:59:59.000Z"
}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({
code: 'DEYVIN_20',
maxRedeems: 10,
discount: 1000,
notes: 'Cupom de desconto pro meu público',
startsAt: '2026-09-01T00:00:00.000Z',
expiresAt: '2026-12-31T23:59:59.000Z'
})
};
fetch('https://api.abacatepay.com/v2/coupons/create', 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.abacatepay.com/v2/coupons/create",
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([
'code' => 'DEYVIN_20',
'maxRedeems' => 10,
'discount' => 1000,
'notes' => 'Cupom de desconto pro meu público',
'startsAt' => '2026-09-01T00:00:00.000Z',
'expiresAt' => '2026-12-31T23:59:59.000Z'
]),
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"Content-Type: application/json"
],
]);
$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.abacatepay.com/v2/coupons/create"
payload := strings.NewReader("{\n \"code\": \"DEYVIN_20\",\n \"maxRedeems\": 10,\n \"discount\": 1000,\n \"notes\": \"Cupom de desconto pro meu público\",\n \"startsAt\": \"2026-09-01T00:00:00.000Z\",\n \"expiresAt\": \"2026-12-31T23:59:59.000Z\"\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Authorization", "Bearer <token>")
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.abacatepay.com/v2/coupons/create")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"code\": \"DEYVIN_20\",\n \"maxRedeems\": 10,\n \"discount\": 1000,\n \"notes\": \"Cupom de desconto pro meu público\",\n \"startsAt\": \"2026-09-01T00:00:00.000Z\",\n \"expiresAt\": \"2026-12-31T23:59:59.000Z\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.abacatepay.com/v2/coupons/create")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"code\": \"DEYVIN_20\",\n \"maxRedeems\": 10,\n \"discount\": 1000,\n \"notes\": \"Cupom de desconto pro meu público\",\n \"startsAt\": \"2026-09-01T00:00:00.000Z\",\n \"expiresAt\": \"2026-12-31T23:59:59.000Z\"\n}"
response = http.request(request)
puts response.read_body{
"data": {
"id": "DEYVIN_20",
"discountKind": "PERCENTAGE",
"discount": 1000,
"status": "ACTIVE",
"createdAt": "2025-05-25T23:43:25.250Z",
"updatedAt": "2025-05-25T23:43:25.250Z",
"notes": "Cupom de desconto pro meu público",
"maxRedeems": -1,
"redeemsCount": 0,
"devMode": true,
"metadata": {}
},
"error": null,
"success": true
}{
"error": "Token de autenticação inválido ou ausente."
}Cupons
Criar um cupom
Permite que você crie um novo cupom que pode ser usado por seus clientes para aplicar descontos.
Alternativa: Você também pode criar e gerenciar seus cupons pelo Dashboard da AbacatePay.
POST
/
coupons
/
create
Criar um cupom
curl --request POST \
--url https://api.abacatepay.com/v2/coupons/create \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"code": "DEYVIN_20",
"maxRedeems": 10,
"discount": 1000,
"notes": "Cupom de desconto pro meu público",
"startsAt": "2026-09-01T00:00:00.000Z",
"expiresAt": "2026-12-31T23:59:59.000Z"
}
'import requests
url = "https://api.abacatepay.com/v2/coupons/create"
payload = {
"code": "DEYVIN_20",
"maxRedeems": 10,
"discount": 1000,
"notes": "Cupom de desconto pro meu público",
"startsAt": "2026-09-01T00:00:00.000Z",
"expiresAt": "2026-12-31T23:59:59.000Z"
}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({
code: 'DEYVIN_20',
maxRedeems: 10,
discount: 1000,
notes: 'Cupom de desconto pro meu público',
startsAt: '2026-09-01T00:00:00.000Z',
expiresAt: '2026-12-31T23:59:59.000Z'
})
};
fetch('https://api.abacatepay.com/v2/coupons/create', 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.abacatepay.com/v2/coupons/create",
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([
'code' => 'DEYVIN_20',
'maxRedeems' => 10,
'discount' => 1000,
'notes' => 'Cupom de desconto pro meu público',
'startsAt' => '2026-09-01T00:00:00.000Z',
'expiresAt' => '2026-12-31T23:59:59.000Z'
]),
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"Content-Type: application/json"
],
]);
$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.abacatepay.com/v2/coupons/create"
payload := strings.NewReader("{\n \"code\": \"DEYVIN_20\",\n \"maxRedeems\": 10,\n \"discount\": 1000,\n \"notes\": \"Cupom de desconto pro meu público\",\n \"startsAt\": \"2026-09-01T00:00:00.000Z\",\n \"expiresAt\": \"2026-12-31T23:59:59.000Z\"\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Authorization", "Bearer <token>")
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.abacatepay.com/v2/coupons/create")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"code\": \"DEYVIN_20\",\n \"maxRedeems\": 10,\n \"discount\": 1000,\n \"notes\": \"Cupom de desconto pro meu público\",\n \"startsAt\": \"2026-09-01T00:00:00.000Z\",\n \"expiresAt\": \"2026-12-31T23:59:59.000Z\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.abacatepay.com/v2/coupons/create")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"code\": \"DEYVIN_20\",\n \"maxRedeems\": 10,\n \"discount\": 1000,\n \"notes\": \"Cupom de desconto pro meu público\",\n \"startsAt\": \"2026-09-01T00:00:00.000Z\",\n \"expiresAt\": \"2026-12-31T23:59:59.000Z\"\n}"
response = http.request(request)
puts response.read_body{
"data": {
"id": "DEYVIN_20",
"discountKind": "PERCENTAGE",
"discount": 1000,
"status": "ACTIVE",
"createdAt": "2025-05-25T23:43:25.250Z",
"updatedAt": "2025-05-25T23:43:25.250Z",
"notes": "Cupom de desconto pro meu público",
"maxRedeems": -1,
"redeemsCount": 0,
"devMode": true,
"metadata": {}
},
"error": null,
"success": true
}{
"error": "Token de autenticação inválido ou ausente."
}Cria um cupom de desconto que seus clientes aplicam no checkout.
Exemplo — R$ 20,00 fixo, válido 50 vezes:
Requer a permissão
COUPON:CREATE.Obrigatórios
code (único na sua loja), discountKind (PERCENTAGE ou FIXED) e discount (valor do desconto).PERCENTAGE desconta uma porcentagem do total, informada em centésimos de ponto percentual: 100 = 1%, 1000 = 10% e o máximo é 10000 (100%). FIXED desconta um valor fixo em centavos (mínimo 100, ou seja, R$ 1,00).
Exemplo — 10% de desconto ilimitado:
{
"code": "BEMVINDO10",
"discountKind": "PERCENTAGE",
"discount": 1000,
"maxRedeems": -1,
"notes": "Cupom de boas-vindas"
}
{
"code": "PROMO20",
"discountKind": "FIXED",
"discount": 2000,
"maxRedeems": 50
}
-1 significa usos ilimitados. Qualquer valor positivo limita o número total de resgates.Authorizations
Todas as requisições devem incluir sua chave de API no header Authorization usando o formato Bearer <abacatepay-api-key>. Sem esse header a requisição será rejeitada.
Saiba mais sobre como criar e usar chaves de API na documentação de autenticação.
Body
application/json
Os dados do seu cupom.
Identificador único do cupom
Example:
"DEYVIN_20"
Quantidade de vezes em que o cupom pode ser resgatado. -1 Significa que esse cupom pode ser resgatado sem limites
Example:
10
Tipo de desconto aplicado, porcentagem ou fixo
Available options:
PERCENTAGE, FIXED Valor do desconto. Em PERCENTAGE, é em centésimos de ponto percentual: 100 = 1%, 1000 = 10% (máximo 10000 = 100%). Em FIXED, é em centavos (mínimo 100 = R$ 1,00).
Required range:
x >= 0Example:
1000
Descrição sbre o cupom
Example:
"Cupom de desconto pro meu público"
Início da validade do cupom. Se omitido, o cupom vale imediatamente. Precisa ser posterior a hoje.
Example:
"2026-09-01T00:00:00.000Z"
Fim da validade do cupom. Se omitido, o cupom não expira. Precisa ser posterior a hoje e a startsAt.
Example:
"2026-12-31T23:59:59.000Z"
Was this page helpful?