Buscar um Cupom

Retorna os dados de um cupom específico baseado em filtros.

Você pode usar essa rota para buscar um cupom por ID ou outros critérios.

GET /coupons/get

Buscar um cupom

cURL

curl --request GET \
  --url https://api.abacatepay.com/v2/coupons/get \
  --header 'Authorization: Bearer <token>'

import requests

url = "https://api.abacatepay.com/v2/coupons/get"

headers = {"Authorization": "Bearer <token>"}

response = requests.get(url, headers=headers)

print(response.text)

const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

fetch('https://api.abacatepay.com/v2/coupons/get', 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/get",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>"
  ],
]);

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

curl_close($curl);

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

package main

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

func main() {

	url := "https://api.abacatepay.com/v2/coupons/get"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("Authorization", "Bearer <token>")

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

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

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.get("https://api.abacatepay.com/v2/coupons/get")
  .header("Authorization", "Bearer <token>")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.abacatepay.com/v2/coupons/get")

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

request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'

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

200

{
  "data": {
    "id": "DEYVIN_20",
    "discountKind": "PERCENTAGE",
    "discount": 123,
    "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."
}

{
  "error": "Cupom não encontrado."
}

Retorna os dados de um cupom pelo seu code.

Requer a permissão COUPON:READ.

Use redeemsCount para acompanhar quantas vezes o cupom já foi utilizado e status para verificar se ainda está ativo.

Authorizations

Authorization · string · header · required

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.

Query Parameters

id · string

Identificador único do cupom

Example:

"MY_COUPON"

Response

200

application/json

Cupom encontrado com sucesso.

data · object

Os dados do seu cupom.

Show child attributes

error · string | null

Example:

null

success · boolean

Se a requisição obteve sucesso ou não.

Example:

true