API Reference
  1. API Smart TEF
  2. Transactions

Criar transação

post
https://api.exemplo.com.br/v1/transactions

Cria uma cobrança e a envia para uma maquininha. A transação nasce com status pending. Direcione a um terminal específico com terminal_id, ou deixe em branco para enviar ao pool do lojista — a primeira maquininha ativa que aceitar executa.

Para estornar uma venda aprovada, use POST /transactions/{id}/refund.

Envie o header Idempotency-Key para que um reenvio por falha de rede não gere duas cobranças.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Body Params
string
required

Chave do lojista dono da cobrança.

string | null

Terminal alvo. Se omitido, a cobrança vai para o pool do lojista e a primeira maquininha ativa que aceitar executa.

string
enum
required

Meio de pagamento. credit é crédito; debit é débito; pix é Pix; voucher é vale/benefício.

Allowed:
integer
≥ 1
Defaults to 1

Número de parcelas. Use 1 para à vista.

string
enum

Quem arca com o juro do parcelado. none é à vista; merchant é parcelado com juros absorvidos pela loja; cardholder é parcelado com juros pagos pelo cliente.

Allowed:
integer
required

Valor em centavos. Ex. 15000 é R$ 150,00; 1050 é R$ 10,50.

string

Seu identificador da venda (ex. número da nota). Volta no retorno e nos webhooks para conciliação, e é a base da idempotência.

string

Texto livre para identificar a cobrança.

boolean
Defaults to true

Se true, a maquininha imprime a via do cliente ao aprovar. Se false, não imprime.

Headers
string

Chave gerada por você para deduplicar reenvios. A mesma chave retorna o resultado da primeira chamada, sem repetir a operação.

Responses

Updated about 3 hours ago

Did this page help you?
Language
Credentials
Bearer
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json

Updated about 3 hours ago

Did this page help you?