Remover cupom

Delete a coupon

curl --request DELETE \
  --url https://api-sandbox.fortalpay.tech/v1/coupons/{id} \
  --header 'Authorization: <api-key>'

const options = {method: 'DELETE', headers: {Authorization: '<api-key>'}};

fetch('https://api-sandbox.fortalpay.tech/v1/coupons/{id}', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

const options = {method: 'DELETE', headers: {Authorization: '<api-key>'}};

fetch('https://api-sandbox.fortalpay.tech/v1/coupons/{id}', 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-sandbox.fortalpay.tech/v1/coupons/{id}",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "DELETE",
  CURLOPT_HTTPHEADER => [
    "Authorization: <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"
	"net/http"
	"io"
)

func main() {

	url := "https://api-sandbox.fortalpay.tech/v1/coupons/{id}"

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

	req.Header.Add("Authorization", "<api-key>")

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

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

	fmt.Println(string(body))

}

using RestSharp;


var options = new RestClientOptions("https://api-sandbox.fortalpay.tech/v1/coupons/{id}");
var client = new RestClient(options);
var request = new RestRequest("");
request.AddHeader("Authorization", "<api-key>");
var response = await client.DeleteAsync(request);

Console.WriteLine("{0}", response.Content);

{
  "data": null,
  "success": false,
  "error": {
    "timestamp": "2023-11-07T05:31:56Z",
    "status": 123,
    "message": "<string>",
    "path": "<string>",
    "fields": [
      {
        "field": "<string>",
        "message": "<string>"
      }
    ]
  }
}

{
  "data": null,
  "success": false,
  "error": {
    "timestamp": "2023-11-07T05:31:56Z",
    "status": 123,
    "message": "<string>",
    "path": "<string>",
    "fields": [
      {
        "field": "<string>",
        "message": "<string>"
      }
    ]
  }
}

{
  "data": null,
  "success": false,
  "error": {
    "timestamp": "2023-11-07T05:31:56Z",
    "status": 123,
    "message": "<string>",
    "path": "<string>",
    "fields": [
      {
        "field": "<string>",
        "message": "<string>"
      }
    ]
  }
}

DELETE

coupons

{id}

Delete a coupon

curl --request DELETE \
  --url https://api-sandbox.fortalpay.tech/v1/coupons/{id} \
  --header 'Authorization: <api-key>'

const options = {method: 'DELETE', headers: {Authorization: '<api-key>'}};

fetch('https://api-sandbox.fortalpay.tech/v1/coupons/{id}', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

const options = {method: 'DELETE', headers: {Authorization: '<api-key>'}};

fetch('https://api-sandbox.fortalpay.tech/v1/coupons/{id}', 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-sandbox.fortalpay.tech/v1/coupons/{id}",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "DELETE",
  CURLOPT_HTTPHEADER => [
    "Authorization: <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"
	"net/http"
	"io"
)

func main() {

	url := "https://api-sandbox.fortalpay.tech/v1/coupons/{id}"

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

	req.Header.Add("Authorization", "<api-key>")

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

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

	fmt.Println(string(body))

}

using RestSharp;


var options = new RestClientOptions("https://api-sandbox.fortalpay.tech/v1/coupons/{id}");
var client = new RestClient(options);
var request = new RestRequest("");
request.AddHeader("Authorization", "<api-key>");
var response = await client.DeleteAsync(request);

Console.WriteLine("{0}", response.Content);

{
  "data": null,
  "success": false,
  "error": {
    "timestamp": "2023-11-07T05:31:56Z",
    "status": 123,
    "message": "<string>",
    "path": "<string>",
    "fields": [
      {
        "field": "<string>",
        "message": "<string>"
      }
    ]
  }
}

{
  "data": null,
  "success": false,
  "error": {
    "timestamp": "2023-11-07T05:31:56Z",
    "status": 123,
    "message": "<string>",
    "path": "<string>",
    "fields": [
      {
        "field": "<string>",
        "message": "<string>"
      }
    ]
  }
}

{
  "data": null,
  "success": false,
  "error": {
    "timestamp": "2023-11-07T05:31:56Z",
    "status": 123,
    "message": "<string>",
    "path": "<string>",
    "fields": [
      {
        "field": "<string>",
        "message": "<string>"
      }
    ]
  }
}

Remove logicamente o cupom e retorna HTTP 204 sem corpo.

curl --request DELETE 'https://api-sandbox.fortalpay.tech/v1/coupons/6f84d2b5-a612-4e67-8af5-69f98de980f5' \
  --header 'Authorization: ApiKey <full_access_api_key>'

Authorizations

Authorization

string

header

required

Todas as requisições devem incluir sua API key no cabeçalho Authorization usando o formato ApiKey <sua_api_key>. Não use o esquema Bearer. Sem esse cabeçalho, a requisição será rejeitada.

Use fpay_sk_test_... no ambiente de teste e fpay_sk_live_... em produção. Saiba como criar e usar uma API key.

Path Parameters

string<uuid>

required

Identificador público do cupom.

Response

Coupon deleted successfully. The response has no body.

Checkouts

Clientes

Produtos

Cupons

Authorizations

Path Parameters

Response