PUT

Cancelar Checkout

Cancele um checkout ativo, impedindo que novos pagamentos sejam realizados através do link. Esta ação não pode ser desfeita.

Endpoint

PUT /api/checkout/{id}/cancel

Parâmetros da URL

Parâmetro Tipo Obrigatório Descrição
id string (GUID) Sim ID único do checkout a ser cancelado

Exemplos de Requisição

curl -X PUT "https://api.recebeaqui.com/v2/api/checkout/123e4567-e89b-12d3-a456-426614174000/cancel" \
  -H "Authorization: Bearer {seu_token_de_api}" \
  -H "Content-Type: application/json"
const checkoutId = "123e4567-e89b-12d3-a456-426614174000";

const response = await fetch(`https://api.recebeaqui.com/v2/api/checkout/${checkoutId}/cancel`, {
  method: 'PUT',
  headers: {
    'Authorization': 'Bearer {seu_token_de_api}',
    'Content-Type': 'application/json'
  }
});

const data = await response.json();
var checkoutId = "123e4567-e89b-12d3-a456-426614174000";

client.DefaultRequestHeaders.Authorization = new AuthenticationHeaderValue("Bearer", "{seu_token_de_api}");
var response = await client.PutAsync($"https://api.recebeaqui.com/v2/api/checkout/{checkoutId}/cancel", null);

var content = await response.Content.ReadAsStringAsync();

Resposta de Sucesso

Em caso de sucesso (código 200), você receberá uma confirmação:

{
  "message": "Link de pagamento/Checkout cancelado com sucesso."
}

Importante