🛍️ API de Venda E-commerce

Este guia apresenta o passo a passo para integração com o serviço de vendas online para plataformas de e-commerce, permitindo processar pagamentos com cartão de crédito de forma segura.

🎯 Visão Geral

A API de Venda E-commerce permite que você:

• 💳 Consulte limites e situação de cartões
• 🔐 Crie pré-autorizações para validar vendas online
• 🎫 Use tokens transacionais para maior segurança
• 🔍 Consulte status de transações
• ❌ Desfaça vendas com cartão ou token
• ✅ Capture (efetive) vendas após aprovação
• 📋 Cancele contratos de vendas

URLs Base:

• Homologação: https://apihml.credsystem.com.br/venda-ecommerce/api/v1
• Produção: https://api.credsystem.com.br/venda-ecommerce/api/v1

📚 Recursos Adicionais

• 🔧 Guia de Troubleshooting - Solução de problemas e erros comuns
• 📖 Especificação OpenAPI — Referência técnica completa (schemas, tipos, exemplos)

---

🔐 Autenticação

Esta API utiliza Oracle IDCS com o fluxo Client Credentials (servidor para servidor).

Todos os endpoints requerem autenticação via Bearer Token (JWT) no header:

Authorization: Bearer <seu_token_jwt>

Propriedade	Valor
Sistema	Oracle IDCS
Fluxo OAuth2	Client Credentials
Tipo	Servidor para Servidor (sem usuário)
Token	Access Token (JWT)

Atenção

Tokens inválidos ou expirados retornarão erro 401 Unauthorized.

🔑 Como obter o token?

Veja o Passo 2 — Entender os Sistemas e o Passo 3 — Exemplos em 7 linguagens para gerar seu Bearer Token.

---

📚 Endpoints Disponíveis

1️⃣ Consultar Limite e Situação do Cartão

Consulta o limite disponível e a situação do cartão antes de realizar uma venda. Use este endpoint para verificar se o cliente tem limite suficiente e quais planos estão disponíveis.

Endpoint: GET /limite-situacao

Parâmetros de consulta:

Parâmetro	Tipo	Local	Obrigatório	Descrição
cartao	string	header	⚠️ Condicional*	Número do cartão do cliente
cpf	string	header	⚠️ Condicional*	CPF do cliente a ser consultado
estabelecimento	integer	query	✅ Sim	Código numérico da ESTABELECIMENTO que está realizando a consulta
valorCompra	number	query	✅ Sim	Valor da compra a ser validado
isInfoPlanos	boolean	query	❌ Não	Quando true, retorna informações detalhadas sobre limites e planos de pagamento disponíveis. Quando false, retorna informações completas do cliente incluindo contratos e parcelas (padrão: false)

⚠️ Condicional

Envie cartao OU cpf — um deles é obrigatório, mas não é necessário enviar ambos.

Exemplos de Requisição:

cURL

curl -X GET "https://apihml.credsystem.com.br/venda-ecommerce/api/v1/limite-situacao?estabelecimento=12345&valorCompra=150.00&isInfoPlanos=true" \
  -H "Authorization: Bearer SEU_TOKEN_JWT" \
  -H "cartao: 1234567890123456" \
  -H "cpf: 12345678901"

JavaScript

const API_BASE = 'https://apihml.credsystem.com.br/venda-ecommerce/api/v1';
const TOKEN = 'SEU_TOKEN_JWT';

const response = await fetch(
  `${API_BASE}/limite-situacao?estabelecimento=12345&valorCompra=150.00&isInfoPlanos=true`,
  {
    headers: {
      'Authorization': `Bearer ${TOKEN}`,
      'cartao': '1234567890123456',
      'cpf': '12345678901'
    }
  }
);

if (!response.ok) {
  const error = await response.json();
  throw new Error(`HTTP ${response.status}: ${error.mensagem}`);
}

const data = await response.json();
console.log('✅ Limite disponível:', data.limiteDisponivel);

Python

import requests

API_BASE = 'https://apihml.credsystem.com.br/venda-ecommerce/api/v1'
TOKEN = 'SEU_TOKEN_JWT'

response = requests.get(
    f'{API_BASE}/limite-situacao',
    params={'estabelecimento': '12345', 'valorCompra': 150.00, 'isInfoPlanos': True},
    headers={
        'Authorization': f'Bearer {TOKEN}',
        'cartao': '1234567890123456',
        'cpf': '12345678901'
    },
    timeout=15
)

response.raise_for_status()
data = response.json()
print('✅ Limite disponível:', data.get('limiteDisponivel'))

Java

import java.net.URI;
import java.net.http.HttpClient;
import java.net.http.HttpRequest;
import java.net.http.HttpResponse;

public class ConsultarLimiteSituacao {
    private static final String API_BASE = "https://apihml.credsystem.com.br/venda-ecommerce/api/v1";
    private static final String TOKEN = "SEU_TOKEN_JWT";

    public static void main(String[] args) throws Exception {
        HttpRequest request = HttpRequest.newBuilder()
            .uri(URI.create(API_BASE + "/limite-situacao?estabelecimento=12345&valorCompra=150.00&isInfoPlanos=true"))
            .header("Authorization", "Bearer " + TOKEN)
            .header("cartao", "1234567890123456")
            .header("cpf", "12345678901")
            .GET()
            .build();

        HttpResponse<String> response = HttpClient.newHttpClient()
            .send(request, HttpResponse.BodyHandlers.ofString());

        if (response.statusCode() == 200) {
            System.out.println("✅ Resposta: " + response.body());
        } else {
            throw new IllegalStateException("Erro HTTP " + response.statusCode() + ": " + response.body());
        }
    }
}

C#

using System;
using System.Net.Http;
using System.Threading.Tasks;

using var client = new HttpClient();
client.DefaultRequestHeaders.Add("Authorization", "Bearer SEU_TOKEN_JWT");
client.DefaultRequestHeaders.Add("cartao", "1234567890123456");
client.DefaultRequestHeaders.Add("cpf", "12345678901");

var response = await client.GetAsync(
    "https://apihml.credsystem.com.br/venda-ecommerce/api/v1/limite-situacao?estabelecimento=12345&valorCompra=150.00&isInfoPlanos=true"
);

response.EnsureSuccessStatusCode();
Console.WriteLine("✅ Resposta: " + await response.Content.ReadAsStringAsync());

PHP

<?php

$ch = curl_init('https://apihml.credsystem.com.br/venda-ecommerce/api/v1/limite-situacao?estabelecimento=12345&valorCompra=150.00&isInfoPlanos=true');
curl_setopt_array($ch, [
    CURLOPT_RETURNTRANSFER => true,
    CURLOPT_HTTPHEADER => [
        'Authorization: Bearer SEU_TOKEN_JWT',
        'cartao: 1234567890123456',
        'cpf: 12345678901',
    ],
]);

$response = curl_exec($ch);
$httpCode = curl_getinfo($ch, CURLINFO_HTTP_CODE);
curl_close($ch);

if ($httpCode === 200) {
    echo "✅ Resposta: " . $response . "\n";
} else {
    echo "❌ Erro HTTP {$httpCode}: {$response}\n";
}

Go

package main

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

func main() {
    req, _ := http.NewRequest(http.MethodGet,
        "https://apihml.credsystem.com.br/venda-ecommerce/api/v1/limite-situacao", nil)
    q := req.URL.Query()
    q.Set("estabelecimento", "12345")
    q.Set("valorCompra", "150.00")
    q.Set("isInfoPlanos", "true")
    req.URL.RawQuery = q.Encode()
    req.Header.Set("Authorization", "Bearer SEU_TOKEN_JWT")
    req.Header.Set("cartao", "1234567890123456")
    req.Header.Set("cpf", "12345678901")

    resp, err := http.DefaultClient.Do(req)
    if err != nil {
        panic(err)
    }
    defer resp.Body.Close()
    body, _ := io.ReadAll(resp.Body)
    fmt.Printf("Status: %s\n", resp.Status)
    fmt.Println(string(body))
}

Exemplo de Resposta (200 Success):

{
  "titular": "João da Silva",
  "numeroCartao": "1234567890123456",
  "nascimento": "01/01/1980",
  "limiteDisponivel": 5000.0,
  "situacaoCartao": "ATIVO",
  "vencimento": "12/2028",
  "dataAtivacao": "2024-01-15",
  "isHabilitadoCompra": true,
  "dscmotivo": "",
  "isClienteTombado": false,
  "dataUltimaCompra": "2026-03-15",
  "temSeguroContratado": false,
  "Planos": [
    {
      "parcelas": 3,
      "tipoParcelamento": "ESTABELECIMENTO",
      "vencimento": "2026-05-15",
      "limiteDisponivel": 5000.0,
      "valorParcela": 50.0,
      "valorCompra": 150.0,
      "valorLimite": 10000.0,
      "isComJuros": false,
      "codigoPlano": "PLANO01"
    }
  ],
  "proximoVencimento": "2026-05-15",
  "dataPrimeiraEmissao": "2026-04-13T23:54:45.686Z"
}

🔄 Primeira Compra / Reativação

Se deseja realizar uma Desconto de primeira compra, utilize o campo dataAtivacao:

• ✅ Campo dataAtivacao presente: Cartão já foi ativado anteriormente
• ❌ Campo dataAtivacao ausente ou nulo: Cartão não foi ativado ainda

Situações especiais:

• Se a situacaoCartao for DESBLOQUEADO ou BLOQUEADO pelo motivo de Emissão, o cliente conseguirá transacionar normalmente na primeira compra
• Após a primeira compra bem-sucedida, o cartão será automaticamente ativado e desbloqueado por emissão

❗ Possíveis Situações do Cartão:

Situação	Pode Comprar?	Descrição
DESBLOQUEADO	✅ Sim	Cartão ativo e funcionando normalmente
BLOQUEADO	✅ Sim	Cartão bloqueado por emissão — pode comprar na primeira compra
BLOQUEADO	❌ Não	Cartão bloqueado temporariamente (verifique dscmotivo para o motivo específico)
CANCELADO	❌ Não	Cartão cancelado definitivamente

Melhor Prática

Consulte o limite antes de exibir as opções de parcelamento no checkout. Assim você mostra apenas as parcelas que o cliente pode realmente utilizar.

Problemas com este endpoint?

Consulte o 🔧 Guia de Troubleshooting - Limite e Situação para erros comuns e ações recomendadas.

---

2️⃣ Criar Pré-Autorização com Cartão

Cria uma pré-autorização de venda online utilizando dados do cartão de crédito. Este passo valida os dados, verifica o limite disponível e reserva o valor para captura posterior.

Endpoint: POST /pre-autorizacoes

Corpo da Requisição:

{
  "estabelecimento": "12345",
  "cartao": {
    "numero": "1234567890123456",
    "nome": "JOAO SILVA",
    "cvv2": "123",
    "validade": "12/2028"
  },
  "venda": {
    "valor": 150.00,
    "quantidadeParcelas": 3,
    "tipoParcelamento": "ESTABELECIMENTO",
    "numeroPedido": "PED-2025-001",
    "codigoPlano": "PLANO01"
  },
  "nsu": "123456789012"
}

Campos da Requisição:

Campo	Tipo	Obrigatório	Descrição
estabelecimento	string	✅ Sim	Código do estabelecimento lojista
cartao.numero	string	✅ Sim	Número do cartão OU Voucher do cartão digital
cartao.nome	string	✅ Sim	Nome do titular impresso no cartão
cartao.cvv2	string	✅ Sim	Código de segurança do cartão
cartao.validade	string	✅ Sim	Data de validade no formato MM/AAAA
venda.valor	number	✅ Sim	Valor total da venda (formato decimal)
venda.quantidadeParcelas	integer	✅ Sim	Quantidade de parcelas (1 para à vista)
venda.tipoParcelamento	string	✅ Sim	Tipo de parcelamento: ESTABELECIMENTO ou ADMINISTRADORA
venda.numeroPedido	string	✅ Sim	Número do pedido no e-commerce
venda.codigoPlano	string	✅ Sim	Código do plano de parcelamento
nsu	string	✅ Sim	Número Sequencial Único da transação (12 dígitos)

Exemplos de Requisição:

cURL

curl -X POST "https://apihml.credsystem.com.br/venda-ecommerce/api/v1/pre-autorizacoes" \
  -H "Authorization: Bearer SEU_TOKEN_JWT" \
  -H "Content-Type: application/json" \
  -d '{
    "estabelecimento": "12345",
    "cartao": {
      "numero": "1234567890123456",
      "nome": "JOAO SILVA",
      "cvv2": "123",
      "validade": "12/2028"
    },
    "venda": {
      "valor": 150.00,
      "quantidadeParcelas": 3,
      "tipoParcelamento": "ESTABELECIMENTO",
      "numeroPedido": "PED-2025-001",
      "codigoPlano": "PLANO01"
    },
    "nsu": "123456789012"
  }'

JavaScript

const API_BASE = 'https://apihml.credsystem.com.br/venda-ecommerce/api/v1';
const TOKEN = 'SEU_TOKEN_JWT';

const response = await fetch(`${API_BASE}/pre-autorizacoes`, {
  method: 'POST',
  headers: {
    'Authorization': `Bearer ${TOKEN}`,
    'Content-Type': 'application/json'
  },
  body: JSON.stringify({
    estabelecimento: '12345',
    cartao: { numero: '1234567890123456', nome: 'JOAO SILVA', cvv2: '123', validade: '12/2028' },
    venda: { valor: 150.00, quantidadeParcelas: 3, tipoParcelamento: 'ESTABELECIMENTO', numeroPedido: 'PED-2025-001', codigoPlano: 'PLANO01' },
    nsu: '123456789012'
  })
});

if (!response.ok) {
  const error = await response.json();
  throw new Error(`HTTP ${response.status}: ${error.mensagem}`);
}
const data = await response.json();
console.log('✅ Pré-autorização:', data.Content.preAutorizacao);

Python

import requests

API_BASE = 'https://apihml.credsystem.com.br/venda-ecommerce/api/v1'
TOKEN = 'SEU_TOKEN_JWT'

payload = {
    'estabelecimento': '12345',
    'cartao': {'numero': '1234567890123456', 'nome': 'JOAO SILVA', 'cvv2': '123', 'validade': '12/2028'},
    'venda': {'valor': 150.00, 'quantidadeParcelas': 3, 'tipoParcelamento': 'ESTABELECIMENTO', 'numeroPedido': 'PED-2025-001', 'codigoPlano': 'PLANO01'},
    'nsu': '123456789012'
}

response = requests.post(
    f'{API_BASE}/pre-autorizacoes',
    json=payload,
    headers={'Authorization': f'Bearer {TOKEN}'},
    timeout=15
)
response.raise_for_status()
data = response.json()
print('✅ Pré-autorização:', data.get('Content', {}).get('preAutorizacao'))

Java

import java.net.URI;
import java.net.http.*;

public class CriarPreAutorizacaoCartao {
    private static final String API_BASE = "https://apihml.credsystem.com.br/venda-ecommerce/api/v1";
    private static final String TOKEN = "SEU_TOKEN_JWT";

    public static void main(String[] args) throws Exception {
        String body = """
            {"estabelecimento":"12345","cartao":{"numero":"1234567890123456","nome":"JOAO SILVA","cvv2":"123","validade":"12/2028"},
            "venda":{"valor":150.00,"quantidadeParcelas":3,"tipoParcelamento":"ESTABELECIMENTO","numeroPedido":"PED-2025-001","codigoPlano":"PLANO01"},"nsu":"123456789012"}
            """;

        HttpRequest request = HttpRequest.newBuilder()
            .uri(URI.create(API_BASE + "/pre-autorizacoes"))
            .header("Authorization", "Bearer " + TOKEN)
            .header("Content-Type", "application/json")
            .POST(HttpRequest.BodyPublishers.ofString(body))
            .build();

        HttpResponse<String> response = HttpClient.newHttpClient()
            .send(request, HttpResponse.BodyHandlers.ofString());
        System.out.println(response.statusCode() + ": " + response.body());
    }
}

C#

using System.Net.Http;
using System.Text;
using System.Text.Json;

var payload = new {
    estabelecimento = "12345",
    cartao = new { numero = "1234567890123456", nome = "JOAO SILVA", cvv2 = "123", validade = "12/2028" },
    venda = new { valor = 150.00, quantidadeParcelas = 3, tipoParcelamento = "ESTABELECIMENTO", numeroPedido = "PED-2025-001", codigoPlano = "PLANO01" },
    nsu = "123456789012"
};

using var client = new HttpClient();
client.DefaultRequestHeaders.Add("Authorization", "Bearer SEU_TOKEN_JWT");
var content = new StringContent(JsonSerializer.Serialize(payload), Encoding.UTF8, "application/json");
var response = await client.PostAsync(
    "https://apihml.credsystem.com.br/venda-ecommerce/api/v1/pre-autorizacoes", content);
Console.WriteLine(await response.Content.ReadAsStringAsync());

PHP

<?php

$payload = [
    'estabelecimento' => '12345',
    'cartao' => ['numero' => '1234567890123456', 'nome' => 'JOAO SILVA', 'cvv2' => '123', 'validade' => '12/2028'],
    'venda' => ['valor' => 150.00, 'quantidadeParcelas' => 3, 'tipoParcelamento' => 'ESTABELECIMENTO', 'numeroPedido' => 'PED-2025-001', 'codigoPlano' => 'PLANO01'],
    'nsu' => '123456789012'
];

$ch = curl_init('https://apihml.credsystem.com.br/venda-ecommerce/api/v1/pre-autorizacoes');
curl_setopt_array($ch, [
    CURLOPT_RETURNTRANSFER => true,
    CURLOPT_POST => true,
    CURLOPT_POSTFIELDS => json_encode($payload),
    CURLOPT_HTTPHEADER => ['Authorization: Bearer SEU_TOKEN_JWT', 'Content-Type: application/json'],
]);
$response = curl_exec($ch);
echo $response;

Go

package main

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

func main() {
    body := []byte(`{"estabelecimento":"12345","cartao":{"numero":"1234567890123456","nome":"JOAO SILVA","cvv2":"123","validade":"12/2028"},"venda":{"valor":150.00,"quantidadeParcelas":3,"tipoParcelamento":"ESTABELECIMENTO","numeroPedido":"PED-2025-001","codigoPlano":"PLANO01"},"nsu":"123456789012"}`)
    req, _ := http.NewRequest(http.MethodPost,
        "https://apihml.credsystem.com.br/venda-ecommerce/api/v1/pre-autorizacoes",
        bytes.NewReader(body))
    req.Header.Set("Authorization", "Bearer SEU_TOKEN_JWT")
    req.Header.Set("Content-Type", "application/json")
    resp, _ := http.DefaultClient.Do(req)
    defer resp.Body.Close()
    b, _ := io.ReadAll(resp.Body)
    fmt.Println(string(b))
}

Exemplo de Resposta (200 Success):

{
  "preAutorizacao": 789012, 
  "mensagem": "Pré-autorização criada com sucesso", 
  "status": "APROVADO"
}

Importante

Guarde o número da preAutorizacao - você precisará dele para capturar (confirmar) a venda.

Problemas com este endpoint?

Consulte o 🔧 Guia de Troubleshooting - Pré-autorização com Cartão para erros comuns e ações recomendadas.

---

3️⃣ Criar Pré-Autorização com Token Transacional

Cria uma pré-autorização utilizando um token transacional em vez dos dados do cartão. Esta é a forma mais segura, pois não expõe informações sensíveis do cartão.

Endpoint: POST /pre-autorizacoes/token

Corpo da Requisição:

{
  "estabelecimento": "12345",
  "nsu": "123456789012",
  "codigoMaquina": "ECOM001",
  "token": 123456,
  "cpf": "12345678901",
  "venda": {
    "valor": 150.00,
    "quantidadeParcelas": 3,
    "tipoParcelamento": "ESTABELECIMENTO",
    "numeroPedido": "PED-2025-001",
    "codigoPlano": "PLANO01"
  }
}

Campos da Requisição:

Campo	Tipo	Obrigatório	Descrição
estabelecimento	string	✅ Sim	Código do estabelecimento e-commerce
nsu	string	✅ Sim	Número Sequencial Único da transação (12 dígitos)
codigoMaquina	string	✅ Sim	Código identificador do e-commerce
token	integer	✅ Sim	Token transacional do cliente
cpf	string	✅ Sim	CPF do cliente (titular do cartão)
venda.valor	number	✅ Sim	Valor total da compra
venda.quantidadeParcelas	integer	✅ Sim	Número de parcelas (1 para à vista)
venda.tipoParcelamento	string	✅ Sim	Tipo de parcelamento: ESTABELECIMENTO ou ADMINISTRADORA
venda.numeroPedido	string	✅ Sim	Número do pedido no e-commerce
venda.codigoPlano	string	✅ Sim	Código do plano de parcelamento

Exemplos de Requisição:

cURL

curl -X POST "https://apihml.credsystem.com.br/venda-ecommerce/api/v1/pre-autorizacoes/token" \
  -H "Authorization: Bearer SEU_TOKEN_JWT" \
  -H "Content-Type: application/json" \
  -d '{
    "estabelecimento": "12345",
    "nsu": "123456789012",
    "codigoMaquina": "ECOM001",
    "token": 123456,
    "cpf": "12345678901",
    "venda": {
      "valor": 150.00,
      "quantidadeParcelas": 3,
      "tipoParcelamento": "ESTABELECIMENTO",
      "numeroPedido": "PED-2025-001",
      "codigoPlano": "PLANO01"
    }
  }'

JavaScript

const API_BASE = 'https://apihml.credsystem.com.br/venda-ecommerce/api/v1';
const TOKEN = 'SEU_TOKEN_JWT';

const response = await fetch(`${API_BASE}/pre-autorizacoes/token`, {
  method: 'POST',
  headers: { 'Authorization': `Bearer ${TOKEN}`, 'Content-Type': 'application/json' },
  body: JSON.stringify({
    estabelecimento: '12345',
    nsu: '123456789012',
    codigoMaquina: 'ECOM001',
    token: 123456,
    cpf: '12345678901',
    venda: { valor: 150.00, quantidadeParcelas: 3, tipoParcelamento: 'ESTABELECIMENTO', numeroPedido: 'PED-2025-001', codigoPlano: 'PLANO01' }
  })
});
const data = await response.json();
console.log('✅ Pré-autorização:', data.Content.preAutorizacao);

Python

import requests

API_BASE = 'https://apihml.credsystem.com.br/venda-ecommerce/api/v1'
TOKEN = 'SEU_TOKEN_JWT'

response = requests.post(
    f'{API_BASE}/pre-autorizacoes/token',
    json={
        'estabelecimento': '12345', 'nsu': '123456789012', 'codigoMaquina': 'ECOM001',
        'token': 123456, 'cpf': '12345678901',
        'venda': {'valor': 150.00, 'quantidadeParcelas': 3, 'tipoParcelamento': 'ESTABELECIMENTO', 'numeroPedido': 'PED-2025-001', 'codigoPlano': 'PLANO01'}
    },
    headers={'Authorization': f'Bearer {TOKEN}'},
    timeout=15
)
response.raise_for_status()
print('✅ Pré-autorização:', response.json().get('Content', {}).get('preAutorizacao'))

Java

import java.net.URI;
import java.net.http.*;

public class CriarPreAutorizacaoToken {
    public static void main(String[] args) throws Exception {
        String body = "{\"estabelecimento\":\"12345\",\"nsu\":\"123456789012\",\"codigoMaquina\":\"ECOM001\",\"token\":123456,\"cpf\":\"12345678901\",\"venda\":{\"valor\":150.00,\"quantidadeParcelas\":3,\"tipoParcelamento\":\"ESTABELECIMENTO\",\"numeroPedido\":\"PED-2025-001\",\"codigoPlano\":\"PLANO01\"}}";
        HttpRequest request = HttpRequest.newBuilder()
            .uri(URI.create("https://apihml.credsystem.com.br/venda-ecommerce/api/v1/pre-autorizacoes/token"))
            .header("Authorization", "Bearer SEU_TOKEN_JWT")
            .header("Content-Type", "application/json")
            .POST(HttpRequest.BodyPublishers.ofString(body))
            .build();
        HttpResponse<String> response = HttpClient.newHttpClient().send(request, HttpResponse.BodyHandlers.ofString());
        System.out.println(response.statusCode() + ": " + response.body());
    }
}

C#

using System.Net.Http;
using System.Text;
using System.Text.Json;

var payload = new {
    estabelecimento = "12345", nsu = "123456789012", codigoMaquina = "ECOM001",
    token = 123456, cpf = "12345678901",
    venda = new { valor = 150.00, quantidadeParcelas = 3, tipoParcelamento = "ESTABELECIMENTO", numeroPedido = "PED-2025-001", codigoPlano = "PLANO01" }
};
using var client = new HttpClient();
client.DefaultRequestHeaders.Add("Authorization", "Bearer SEU_TOKEN_JWT");
var content = new StringContent(JsonSerializer.Serialize(payload), Encoding.UTF8, "application/json");
var response = await client.PostAsync(
    "https://apihml.credsystem.com.br/venda-ecommerce/api/v1/pre-autorizacoes/token", content);
Console.WriteLine(await response.Content.ReadAsStringAsync());

PHP

<?php

$payload = [
    'estabelecimento' => '12345', 'nsu' => '123456789012', 'codigoMaquina' => 'ECOM001',
    'token' => 123456, 'cpf' => '12345678901',
    'venda' => ['valor' => 150.00, 'quantidadeParcelas' => 3, 'tipoParcelamento' => 'ESTABELECIMENTO', 'numeroPedido' => 'PED-2025-001', 'codigoPlano' => 'PLANO01']
];
$ch = curl_init('https://apihml.credsystem.com.br/venda-ecommerce/api/v1/pre-autorizacoes/token');
curl_setopt_array($ch, [
    CURLOPT_RETURNTRANSFER => true, CURLOPT_POST => true,
    CURLOPT_POSTFIELDS => json_encode($payload),
    CURLOPT_HTTPHEADER => ['Authorization: Bearer SEU_TOKEN_JWT', 'Content-Type: application/json'],
]);
echo curl_exec($ch);

Go

package main

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

func main() {
    body := []byte(`{"estabelecimento":"12345","nsu":"123456789012","codigoMaquina":"ECOM001","token":123456,"cpf":"12345678901","venda":{"valor":150.00,"quantidadeParcelas":3,"tipoParcelamento":"ESTABELECIMENTO","numeroPedido":"PED-2025-001","codigoPlano":"PLANO01"}}`)
    req, _ := http.NewRequest(http.MethodPost,
        "https://apihml.credsystem.com.br/venda-ecommerce/api/v1/pre-autorizacoes/token",
        bytes.NewReader(body))
    req.Header.Set("Authorization", "Bearer SEU_TOKEN_JWT")
    req.Header.Set("Content-Type", "application/json")
    resp, _ := http.DefaultClient.Do(req)
    defer resp.Body.Close()
    b, _ := io.ReadAll(resp.Body)
    fmt.Println(string(b))
}

Exemplo de Resposta (200 Success):

{
  "preAutorizacao": 789012, 
  "mensagem": "Pré-autorização criada com sucesso", 
  "status": "APROVADO"
}

Vantagens do Token Transacional

• 🔒 Maior segurança - Dados do cartão não trafegam na requisição
• 🚀 Mais rápido - Cliente não precisa digitar dados do cartão novamente
• 💳 Melhor experiência - Checkout simplificado para clientes recorrentes
• ✅ PCI Compliance - Reduz escopo de conformidade PCI DSS

Importante

Guarde o número da preAutorizacao - você precisará dele para capturar (confirmar) a venda.

Problemas com este endpoint?

Consulte o 🔧 Guia de Troubleshooting - Pré-autorização com Token para erros comuns e ações recomendadas.

---

4️⃣ Consultar Status da Pré-Autorização

Consulta o status atual de uma pré-autorização criada.

Endpoint: GET /pre-autorizacoes/sonda/{preautorizacao}

Parâmetros de consulta:

• preautorizacao (string, via query, obrigatório) - Número pré-autorização a ser consultada.

Exemplos de Requisição:

cURL

curl -X GET "https://apihml.credsystem.com.br/venda-ecommerce/api/v1/pre-autorizacoes/sonda/789012" \
  -H "Authorization: Bearer SEU_TOKEN_JWT"

JavaScript

const response = await fetch(
  'https://apihml.credsystem.com.br/venda-ecommerce/api/v1/pre-autorizacoes/sonda/789012',
  { headers: { 'Authorization': 'Bearer SEU_TOKEN_JWT' } }
);
const data = await response.json();
console.log('✅ Situação:', data.Content.situacao);

Python

import requests

response = requests.get(
    'https://apihml.credsystem.com.br/venda-ecommerce/api/v1/pre-autorizacoes/sonda/789012',
    headers={'Authorization': 'Bearer SEU_TOKEN_JWT'},
    timeout=15
)
response.raise_for_status()
print('✅ Situação:', response.json().get('Content', {}).get('situacao'))

Java

import java.net.URI;
import java.net.http.*;

public class ConsultarSonda {
    public static void main(String[] args) throws Exception {
        HttpRequest request = HttpRequest.newBuilder()
            .uri(URI.create("https://apihml.credsystem.com.br/venda-ecommerce/api/v1/pre-autorizacoes/sonda/789012"))
            .header("Authorization", "Bearer SEU_TOKEN_JWT")
            .GET().build();
        HttpResponse<String> response = HttpClient.newHttpClient().send(request, HttpResponse.BodyHandlers.ofString());
        System.out.println(response.body());
    }
}

C#

using var client = new HttpClient();
client.DefaultRequestHeaders.Add("Authorization", "Bearer SEU_TOKEN_JWT");
var response = await client.GetAsync(
    "https://apihml.credsystem.com.br/venda-ecommerce/api/v1/pre-autorizacoes/sonda/789012");
Console.WriteLine(await response.Content.ReadAsStringAsync());

PHP

<?php
$ch = curl_init('https://apihml.credsystem.com.br/venda-ecommerce/api/v1/pre-autorizacoes/sonda/789012');
curl_setopt_array($ch, [
    CURLOPT_RETURNTRANSFER => true,
    CURLOPT_HTTPHEADER => ['Authorization: Bearer SEU_TOKEN_JWT'],
]);
echo curl_exec($ch);

Go

package main

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

func main() {
    req, _ := http.NewRequest(http.MethodGet,
        "https://apihml.credsystem.com.br/venda-ecommerce/api/v1/pre-autorizacoes/sonda/789012", nil)
    req.Header.Set("Authorization", "Bearer SEU_TOKEN_JWT")
    resp, _ := http.DefaultClient.Do(req)
    defer resp.Body.Close()
    b, _ := io.ReadAll(resp.Body)
    fmt.Println(string(b))
}

Exemplo de Resposta (200 Success):

{
  "preAutorizacao": 789012,
  "status": "APROVADO",  
  "valor": 200,
  "dataHora": "2026-04-13T23:54:45.686Z"
}

Possíveis Situações:

Situação	Descrição	Próximo Passo
PENDENTE_CAPTURA	Pré-autorização aprovada, aguardando captura	Capturar a venda
CAPTURADO	Venda já capturada (confirmada)	Venda concluída
CANCELADO	Pré-autorização cancelada	Criar nova pré-autorização
EXPIRADO	Tempo de captura expirado	Criar nova pré-autorização
NEGADO	Pré-autorização negada	Verificar limite/dados do cartão

Problemas com este endpoint?

Consulte o 🔧 Guia de Troubleshooting - Consulta Status para erros comuns e ações recomendadas.

---

5️⃣ Capturar (Confirmar) Venda

Confirma e efetiva a venda após a pré-autorização ser aprovada. Este é o passo que realmente debita o valor do cliente.

Endpoint: POST /pre-autorizacoes/captura

Importante

A captura deve ser feita em até 5 dias após a pré-autorização. Após esse prazo, a pré-autorização expira.

Corpo da Requisição:

{
  "estabelecimento": "12345",
  "preAutorizacao": 789012,
  "numeroPedido": "PED-2025-001",
  "valor": 150.00
}

Campos da Requisição:

Campo	Tipo	Obrigatório	Descrição
estabelecimento	string	✅ Sim	Código do estabelecimento e-commerce
preAutorizacao	integer	✅ Sim	Número da pré-autorização a ser capturada
numeroPedido	string	✅ Sim	Número do pedido no e-commerce
valor	number	✅ Sim	Valor a ser capturado (deve ser igual ou menor que o valor pré-autorizado)

Exemplos de Requisição:

cURL

curl -X POST "https://apihml.credsystem.com.br/venda-ecommerce/api/v1/pre-autorizacoes/captura" \
  -H "Authorization: Bearer SEU_TOKEN_JWT" \
  -H "Content-Type: application/json" \
  -d '{
    "estabelecimento": "12345",
    "preAutorizacao": 789012,
    "numeroPedido": "PED-2025-001",
    "valor": 150.00
  }'

JavaScript

const response = await fetch(
  'https://apihml.credsystem.com.br/venda-ecommerce/api/v1/pre-autorizacoes/captura',
  {
    method: 'POST',
    headers: { 'Authorization': 'Bearer SEU_TOKEN_JWT', 'Content-Type': 'application/json' },
    body: JSON.stringify({ estabelecimento: '12345', preAutorizacao: 789012, numeroPedido: 'PED-2025-001', valor: 150.00 })
  }
);
const data = await response.json();
console.log('✅ Contrato:', data.Content.numeroContrato);

Python

import requests

response = requests.post(
    'https://apihml.credsystem.com.br/venda-ecommerce/api/v1/pre-autorizacoes/captura',
    json={'estabelecimento': '12345', 'preAutorizacao': 789012, 'numeroPedido': 'PED-2025-001', 'valor': 150.00},
    headers={'Authorization': 'Bearer SEU_TOKEN_JWT'},
    timeout=15
)
response.raise_for_status()
print('✅ Contrato:', response.json().get('Content', {}).get('numeroContrato'))

Java

import java.net.URI;
import java.net.http.*;

public class CapturarVenda {
    public static void main(String[] args) throws Exception {
        String body = "{\"estabelecimento\":\"12345\",\"preAutorizacao\":789012,\"numeroPedido\":\"PED-2025-001\",\"valor\":150.00}";
        HttpRequest request = HttpRequest.newBuilder()
            .uri(URI.create("https://apihml.credsystem.com.br/venda-ecommerce/api/v1/pre-autorizacoes/captura"))
            .header("Authorization", "Bearer SEU_TOKEN_JWT")
            .header("Content-Type", "application/json")
            .POST(HttpRequest.BodyPublishers.ofString(body))
            .build();
        HttpResponse<String> response = HttpClient.newHttpClient().send(request, HttpResponse.BodyHandlers.ofString());
        System.out.println(response.body());
    }
}

C#

using System.Net.Http;
using System.Text;
using System.Text.Json;

var payload = new { estabelecimento = "12345", preAutorizacao = 789012, numeroPedido = "PED-2025-001", valor = 150.00 };
using var client = new HttpClient();
client.DefaultRequestHeaders.Add("Authorization", "Bearer SEU_TOKEN_JWT");
var content = new StringContent(JsonSerializer.Serialize(payload), Encoding.UTF8, "application/json");
var response = await client.PostAsync(
    "https://apihml.credsystem.com.br/venda-ecommerce/api/v1/pre-autorizacoes/captura", content);
Console.WriteLine(await response.Content.ReadAsStringAsync());

PHP

<?php

$ch = curl_init('https://apihml.credsystem.com.br/venda-ecommerce/api/v1/pre-autorizacoes/captura');
curl_setopt_array($ch, [
    CURLOPT_RETURNTRANSFER => true,
    CURLOPT_POST => true,
    CURLOPT_POSTFIELDS => json_encode(['estabelecimento' => '12345', 'preAutorizacao' => 789012, 'numeroPedido' => 'PED-2025-001', 'valor' => 150.00]),
    CURLOPT_HTTPHEADER => ['Authorization: Bearer SEU_TOKEN_JWT', 'Content-Type: application/json'],
]);
echo curl_exec($ch);

Go

package main

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

func main() {
    body := []byte(`{"estabelecimento":"12345","preAutorizacao":789012,"numeroPedido":"PED-2025-001","valor":150.00}`)
    req, _ := http.NewRequest(http.MethodPost,
        "https://apihml.credsystem.com.br/venda-ecommerce/api/v1/pre-autorizacoes/captura",
        bytes.NewReader(body))
    req.Header.Set("Authorization", "Bearer SEU_TOKEN_JWT")
    req.Header.Set("Content-Type", "application/json")
    resp, _ := http.DefaultClient.Do(req)
    defer resp.Body.Close()
    b, _ := io.ReadAll(resp.Body)
    fmt.Println(string(b))
}

Exemplo de Resposta (201 Created):

{
  "contrato": "950044877", 
  "valorPrestacao": 200, 
  "primeiroVencimento": "2025-12-03T14:35:00.000Z", 
  "comprovante": "Comprovante em formato texto para impressora térmica"
}

🖨️ Formato do Comprovante

O campo comprovante retorna um texto formatado pronto para impressão em impressora térmica. Você pode enviar diretamente para a impressora sem necessidade de processamento adicional.

Venda Confirmada!

O cliente foi debitado e a venda foi concluída. Você pode liberar o produto/serviço.

Problemas com este endpoint?

Consulte o 🔧 Guia de Troubleshooting - Captura para erros comuns e ações recomendadas.

---

6️⃣ Desfazer Venda

Desfaz (estorna) uma venda online realizada. Use este endpoint quando o cliente solicitar o cancelamento de uma compra ou em caso de erro na transação.

Prazo para Desfazimento

O desfazimento geralmente deve ser realizado no mesmo dia da venda. Verifique as políticas da sua rede.

6️⃣.1️⃣ Desfazer com Dados do Cartão

Desfaz (estorna) uma venda online realizada utilizando os dados do cartão.

Endpoint: POST /desfazimento/cartao

Corpo da Requisição:

{
  "estabelecimento": "12345",
  "valor": 250.00,
  "nsu": "123456789012",
  "codigoMaquina": "ECOM001",
  "cartao": "1234567890123456"
}

Campos da Requisição:

Campo	Tipo	Obrigatório	Descrição
estabelecimento	string	✅ Sim	Código do estabelecimento e-commerce
valor	number	✅ Sim	Valor a ser estornado
nsu	string	✅ Sim	NSU da transação original (12 dígitos)
codigoMaquina	string	✅ Sim	Código identificador do e-commerce
cartao	string	✅ Sim	Número do cartão usado na venda

Exemplos de Requisição:

cURL

curl -X POST "https://apihml.credsystem.com.br/venda-ecommerce/api/v1/desfazimento/cartao" \
  -H "Authorization: Bearer SEU_TOKEN_JWT" \
  -H "Content-Type: application/json" \
  -d '{
    "estabelecimento": "12345",
    "valor": 150.00,
    "nsu": "123456789012",
    "codigoMaquina": "ECOM001",
    "cartao": "1234567890123456"
  }'

JavaScript

const response = await fetch(
  'https://apihml.credsystem.com.br/venda-ecommerce/api/v1/desfazimento/cartao',
  {
    method: 'POST',
    headers: { 'Authorization': 'Bearer SEU_TOKEN_JWT', 'Content-Type': 'application/json' },
    body: JSON.stringify({ estabelecimento: '12345', valor: 150.00, nsu: '123456789012', codigoMaquina: 'ECOM001', cartao: '1234567890123456' })
  }
);
const data = await response.json();
console.log('✅ Status:', data.Content?.status);

Python

import requests

response = requests.post(
    'https://apihml.credsystem.com.br/venda-ecommerce/api/v1/desfazimento/cartao',
    json={'estabelecimento': '12345', 'valor': 150.00, 'nsu': '123456789012', 'codigoMaquina': 'ECOM001', 'cartao': '1234567890123456'},
    headers={'Authorization': 'Bearer SEU_TOKEN_JWT'},
    timeout=15
)
response.raise_for_status()
print('✅ Status:', response.json().get('Content', {}).get('status'))

Java

import java.net.URI;
import java.net.http.*;

public class DesfazimentoCartao {
    public static void main(String[] args) throws Exception {
        String body = "{\"estabelecimento\":\"12345\",\"valor\":150.00,\"nsu\":\"123456789012\",\"codigoMaquina\":\"ECOM001\",\"cartao\":\"1234567890123456\"}";
        HttpRequest request = HttpRequest.newBuilder()
            .uri(URI.create("https://apihml.credsystem.com.br/venda-ecommerce/api/v1/desfazimento/cartao"))
            .header("Authorization", "Bearer SEU_TOKEN_JWT")
            .header("Content-Type", "application/json")
            .POST(HttpRequest.BodyPublishers.ofString(body))
            .build();
        HttpResponse<String> response = HttpClient.newHttpClient().send(request, HttpResponse.BodyHandlers.ofString());
        System.out.println(response.body());
    }
}

C#

using System.Net.Http;
using System.Text;
using System.Text.Json;

var payload = new { estabelecimento = "12345", valor = 150.00, nsu = "123456789012", codigoMaquina = "ECOM001", cartao = "1234567890123456" };
using var client = new HttpClient();
client.DefaultRequestHeaders.Add("Authorization", "Bearer SEU_TOKEN_JWT");
var content = new StringContent(JsonSerializer.Serialize(payload), Encoding.UTF8, "application/json");
var response = await client.PostAsync(
    "https://apihml.credsystem.com.br/venda-ecommerce/api/v1/desfazimento/cartao", content);
Console.WriteLine(await response.Content.ReadAsStringAsync());

PHP

<?php

$ch = curl_init('https://apihml.credsystem.com.br/venda-ecommerce/api/v1/desfazimento/cartao');
curl_setopt_array($ch, [
    CURLOPT_RETURNTRANSFER => true,
    CURLOPT_POST => true,
    CURLOPT_POSTFIELDS => json_encode(['estabelecimento' => '12345', 'valor' => 150.00, 'nsu' => '123456789012', 'codigoMaquina' => 'ECOM001', 'cartao' => '1234567890123456']),
    CURLOPT_HTTPHEADER => ['Authorization: Bearer SEU_TOKEN_JWT', 'Content-Type: application/json'],
]);
echo curl_exec($ch);

Go

package main

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

func main() {
    body := []byte(`{"estabelecimento":"12345","valor":150.00,"nsu":"123456789012","codigoMaquina":"ECOM001","cartao":"1234567890123456"}`)
    req, _ := http.NewRequest(http.MethodPost,
        "https://apihml.credsystem.com.br/venda-ecommerce/api/v1/desfazimento/cartao",
        bytes.NewReader(body))
    req.Header.Set("Authorization", "Bearer SEU_TOKEN_JWT")
    req.Header.Set("Content-Type", "application/json")
    resp, _ := http.DefaultClient.Do(req)
    defer resp.Body.Close()
    b, _ := io.ReadAll(resp.Body)
    fmt.Println(string(b))
}

Exemplo de Resposta (201 Created):

{
  "nsu": "123456789012",
  "mensagem": "Venda desfeita com sucesso", 
  "status": "ESTORNADO"
}

Problemas com este endpoint?

Consulte o 🔧 Guia de Troubleshooting - Desfazimento para erros comuns e ações recomendadas.

---

6️⃣.2️⃣ Desfazer com Token Transacional

Desfaz (estorna) uma venda online realizada utilizando o token transacional em vez dos dados do cartão.

Endpoint: POST /desfazimento/token

Corpo da Requisição:

{
  "estabelecimento": "12345",
  "valor": 150.00,
  "nsu": "123456789012",
  "codigoMaquina": "ECOM001",
  "token": "123456",
  "cpf": "12345678901"
}

Campos da Requisição:

Campo	Tipo	Obrigatório	Descrição
estabelecimento	string	✅ Sim	Código do estabelecimento e-commerce
valor	number	✅ Sim	Valor a ser estornado
nsu	string	✅ Sim	NSU da transação original (12 dígitos)
codigoMaquina	string	✅ Sim	Código identificador do e-commerce
token	string	✅ Sim	Token transacional usado na venda
cpf	string	✅ Sim	CPF do cliente

Exemplos de Requisição:

cURL

curl -X POST "https://apihml.credsystem.com.br/venda-ecommerce/api/v1/desfazimento/token" \
  -H "Authorization: Bearer SEU_TOKEN_JWT" \
  -H "Content-Type: application/json" \
  -d '{
    "estabelecimento": "12345",
    "valor": 150.00,
    "nsu": "123456789012",
    "codigoMaquina": "ECOM001",
    "token": "123456",
    "cpf": "12345678901"
  }'

JavaScript

const response = await fetch(
  'https://apihml.credsystem.com.br/venda-ecommerce/api/v1/desfazimento/token',
  {
    method: 'POST',
    headers: { 'Authorization': 'Bearer SEU_TOKEN_JWT', 'Content-Type': 'application/json' },
    body: JSON.stringify({ estabelecimento: '12345', valor: 150.00, nsu: '123456789012', codigoMaquina: 'ECOM001', token: '123456', cpf: '12345678901' })
  }
);
const data = await response.json();
console.log('✅ Status:', data.Content?.status);

Python

import requests

response = requests.post(
    'https://apihml.credsystem.com.br/venda-ecommerce/api/v1/desfazimento/token',
    json={'estabelecimento': '12345', 'valor': 150.00, 'nsu': '123456789012', 'codigoMaquina': 'ECOM001', 'token': '123456', 'cpf': '12345678901'},
    headers={'Authorization': 'Bearer SEU_TOKEN_JWT'},
    timeout=15
)
response.raise_for_status()
print('✅ Status:', response.json().get('Content', {}).get('status'))

Java

import java.net.URI;
import java.net.http.*;

public class DesfazimentoToken {
    public static void main(String[] args) throws Exception {
        String body = "{\"estabelecimento\":\"12345\",\"valor\":150.00,\"nsu\":\"123456789012\",\"codigoMaquina\":\"ECOM001\",\"token\":\"123456\",\"cpf\":\"12345678901\"}";
        HttpRequest request = HttpRequest.newBuilder()
            .uri(URI.create("https://apihml.credsystem.com.br/venda-ecommerce/api/v1/desfazimento/token"))
            .header("Authorization", "Bearer SEU_TOKEN_JWT")
            .header("Content-Type", "application/json")
            .POST(HttpRequest.BodyPublishers.ofString(body))
            .build();
        HttpResponse<String> response = HttpClient.newHttpClient().send(request, HttpResponse.BodyHandlers.ofString());
        System.out.println(response.body());
    }
}

C#

using System.Net.Http;
using System.Text;
using System.Text.Json;

var payload = new { estabelecimento = "12345", valor = 150.00, nsu = "123456789012", codigoMaquina = "ECOM001", token = "123456", cpf = "12345678901" };
using var client = new HttpClient();
client.DefaultRequestHeaders.Add("Authorization", "Bearer SEU_TOKEN_JWT");
var content = new StringContent(JsonSerializer.Serialize(payload), Encoding.UTF8, "application/json");
var response = await client.PostAsync(
    "https://apihml.credsystem.com.br/venda-ecommerce/api/v1/desfazimento/token", content);
Console.WriteLine(await response.Content.ReadAsStringAsync());

PHP

<?php

$ch = curl_init('https://apihml.credsystem.com.br/venda-ecommerce/api/v1/desfazimento/token');
curl_setopt_array($ch, [
    CURLOPT_RETURNTRANSFER => true,
    CURLOPT_POST => true,
    CURLOPT_POSTFIELDS => json_encode(['estabelecimento' => '12345', 'valor' => 150.00, 'nsu' => '123456789012', 'codigoMaquina' => 'ECOM001', 'token' => '123456', 'cpf' => '12345678901']),
    CURLOPT_HTTPHEADER => ['Authorization: Bearer SEU_TOKEN_JWT', 'Content-Type: application/json'],
]);
echo curl_exec($ch);

Go

package main

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

func main() {
    body := []byte(`{"estabelecimento":"12345","valor":150.00,"nsu":"123456789012","codigoMaquina":"ECOM001","token":"123456","cpf":"12345678901"}`)
    req, _ := http.NewRequest(http.MethodPost,
        "https://apihml.credsystem.com.br/venda-ecommerce/api/v1/desfazimento/token",
        bytes.NewReader(body))
    req.Header.Set("Authorization", "Bearer SEU_TOKEN_JWT")
    req.Header.Set("Content-Type", "application/json")
    resp, _ := http.DefaultClient.Do(req)
    defer resp.Body.Close()
    b, _ := io.ReadAll(resp.Body)
    fmt.Println(string(b))
}

Exemplo de Resposta (201 Created):

{  
  "nsu": "123456789012",
  "mensagem": "Venda desfeita com sucesso", 
  "status": "ESTORNADO"
}

Problemas com este endpoint?

Consulte o 🔧 Guia de Troubleshooting - Desfazimento para erros comuns e ações recomendadas.

---

7️⃣ Cancelar Contrato

Cancela um contrato de venda online previamente criado.

Endpoint: POST /contrato/cancelamento

Corpo da Requisição:

{
  "estabelecimento": "12345",
  "identificador": "PDV01",
  "contrato": "456789",
  "codigoMaquina": "MAQ001",
  "cartao": "1234567890123456",
  "tarja": "1234567890123456",
  "voucher": "VOUCHER123",
  "cpf": "12345678901"
}

Campos da Requisição:

Campo	Tipo	Obrigatório	Descrição
estabelecimento	string	✅ Sim	Código do estabelecimento e-commerce
identificador	string	✅ Sim	Identificador do ponto de venda (PDV)
contrato	string	✅ Sim	Número do contrato a ser cancelado
codigoMaquina	string	✅ Sim	Código da máquina/terminal
cartao	string	⚠️ Condicional*	Número do cartão
tarja	string	⚠️ Condicional*	Número do cartão (tarja magnética)
voucher	string	⚠️ Condicional*	Voucher do cartão digital (para cartões digitais)
cpf	string	✅ Sim	CPF do cliente

⚠️ Condicional

Envie cartao OU tarja OU voucher — um deles é obrigatório, mas não é necessário enviar mais de um.

Exemplos de Requisição:

cURL

curl -X POST "https://apihml.credsystem.com.br/venda-ecommerce/api/v1/contrato/cancelamento" \
  -H "Authorization: Bearer SEU_TOKEN_JWT" \
  -H "Content-Type: application/json" \
  -d '{
    "estabelecimento": "12345",
    "identificador": "PDV01",
    "contrato": "456789",
    "codigoMaquina": "MAQ001",
    "cartao": "1234567890123456",
    "tarja": "1234567890123456",
    "cpf": "12345678901"
  }'

JavaScript

const response = await fetch(
  'https://apihml.credsystem.com.br/venda-ecommerce/api/v1/contrato/cancelamento',
  {
    method: 'POST',
    headers: { 'Authorization': 'Bearer SEU_TOKEN_JWT', 'Content-Type': 'application/json' },
    body: JSON.stringify({
      estabelecimento: '12345', identificador: 'PDV01', contrato: '456789',
      codigoMaquina: 'MAQ001', cartao: '1234567890123456', tarja: '1234567890123456', cpf: '12345678901'
    })
  }
);
const data = await response.json();
console.log('✅ Status:', data.Content.status);

Python

import requests

response = requests.post(
    'https://apihml.credsystem.com.br/venda-ecommerce/api/v1/contrato/cancelamento',
    json={
        'estabelecimento': '12345', 'identificador': 'PDV01', 'contrato': '456789',
        'codigoMaquina': 'MAQ001', 'cartao': '1234567890123456', 'tarja': '1234567890123456', 'cpf': '12345678901'
    },
    headers={'Authorization': 'Bearer SEU_TOKEN_JWT'},
    timeout=15
)
response.raise_for_status()
print('✅ Status:', response.json().get('Content', {}).get('status'))

Java

import java.net.URI;
import java.net.http.*;

public class CancelarContrato {
    public static void main(String[] args) throws Exception {
        String body = "{\"estabelecimento\":\"12345\",\"identificador\":\"PDV01\",\"contrato\":\"456789\",\"codigoMaquina\":\"MAQ001\",\"cartao\":\"1234567890123456\",\"tarja\":\"1234567890123456\",\"cpf\":\"12345678901\"}";
        HttpRequest request = HttpRequest.newBuilder()
            .uri(URI.create("https://apihml.credsystem.com.br/venda-ecommerce/api/v1/contrato/cancelamento"))
            .header("Authorization", "Bearer SEU_TOKEN_JWT")
            .header("Content-Type", "application/json")
            .POST(HttpRequest.BodyPublishers.ofString(body))
            .build();
        HttpResponse<String> response = HttpClient.newHttpClient().send(request, HttpResponse.BodyHandlers.ofString());
        System.out.println(response.body());
    }
}

C#

using System.Net.Http;
using System.Text;
using System.Text.Json;

var payload = new {
    estabelecimento = "12345", identificador = "PDV01", contrato = "456789",
    codigoMaquina = "MAQ001", cartao = "1234567890123456", tarja = "1234567890123456", cpf = "12345678901"
};
using var client = new HttpClient();
client.DefaultRequestHeaders.Add("Authorization", "Bearer SEU_TOKEN_JWT");
var content = new StringContent(JsonSerializer.Serialize(payload), Encoding.UTF8, "application/json");
var response = await client.PostAsync(
    "https://apihml.credsystem.com.br/venda-ecommerce/api/v1/contrato/cancelamento", content);
Console.WriteLine(await response.Content.ReadAsStringAsync());

PHP

<?php

$ch = curl_init('https://apihml.credsystem.com.br/venda-ecommerce/api/v1/contrato/cancelamento');
curl_setopt_array($ch, [
    CURLOPT_RETURNTRANSFER => true,
    CURLOPT_POST => true,
    CURLOPT_POSTFIELDS => json_encode([
        'estabelecimento' => '12345', 'identificador' => 'PDV01', 'contrato' => '456789',
        'codigoMaquina' => 'MAQ001', 'cartao' => '1234567890123456', 'tarja' => '1234567890123456', 'cpf' => '12345678901'
    ]),
    CURLOPT_HTTPHEADER => ['Authorization: Bearer SEU_TOKEN_JWT', 'Content-Type: application/json'],
]);
echo curl_exec($ch);

Go

package main

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

func main() {
    body := []byte(`{"estabelecimento":"12345","identificador":"PDV01","contrato":"456789","codigoMaquina":"MAQ001","cartao":"1234567890123456","tarja":"1234567890123456","cpf":"12345678901"}`)
    req, _ := http.NewRequest(http.MethodPost,
        "https://apihml.credsystem.com.br/venda-ecommerce/api/v1/contrato/cancelamento",
        bytes.NewReader(body))
    req.Header.Set("Authorization", "Bearer SEU_TOKEN_JWT")
    req.Header.Set("Content-Type", "application/json")
    resp, _ := http.DefaultClient.Do(req)
    defer resp.Body.Close()
    b, _ := io.ReadAll(resp.Body)
    fmt.Println(string(b))
}

Exemplo de Resposta (200 Success):

{
  "StatusCode": 200,
  "ReasonPhrase": "OK",
  "HttpVersion": "1.1",
  "Content": {
    "mensagem": "Cancelamento realizado com sucesso",
    "contrato": "456789",
    "status": "CANCELADO",
    "dataHora": "2025-12-03T16:30:00.000Z"
  }
}

Problemas com este endpoint?

Consulte o 🔧 Guia de Troubleshooting - Cancelamento de Contrato para erros comuns e ações recomendadas.

---

🔄 Fluxo Completo de Venda

Fluxo 1: Venda com Dados do Cartão

Fluxo 2: Venda com Token Transacional

---

💡 Dicas e Boas Práticas

✅ Recomendações

1. Valide os dados antes de enviar - Verifique CPF, valores e códigos localmente antes de fazer a requisição
2. Armazene o traceId - Use para rastrear problemas com o suporte técnico
3. Implemente retry com backoff - Em caso de erro 503, tente novamente após alguns segundos
4. Cache de tokens - Evite gerar novos tokens a cada requisição
5. Valide pré-autorizações - Sempre consulte o status antes de efetivar
6. Desfazimento no mesmo dia - Implemente controle para permitir desfazimento apenas no dia da efetivação

❌ Evite

1. ❌ Não exponha o token JWT no frontend
2. ❌ Não tente efetivar pré-autorizações manualmente
3. ❌ Não ignore os códigos de status HTTP
4. ❌ Não faça polling excessivo no endpoint de status

🆘 Suporte

Contato Técnico

• Email: suporte.tecnico@credsystem.com.br
• Horário: Segunda a Sexta, 8h às 18h (BRT)

Em Caso de Erro

1. Anote o traceId retornado no erro
2. Capture a requisição completa (sem dados sensíveis)
3. Descreva o comportamento esperado vs. obtido
4. Envie para o email de suporte com assunto: [API Venda Ecommerce] - Descrição do Problema

---