API Smart TEF
  1. Pagamentos
API Smart TEF
  • Início
    • Veloce.tech - API Smart Tef
  • Token
    • Gerar
      POST
  • Pagamentos
    • Criar
      POST
    • Cancelar
      POST
    • Listar
      GET
    • Rejeitar
      POST
  • Impressão XML
    • Enviar
      POST
  1. Pagamentos

Criar

POST
https://api.veloce.tech/api/v1/pagamento/criar
Última modificação:2025-04-04 19:22:27

Informações complementares#

Parâmetros sempre obrigatórios:#

1.
Valor: Define o valor do pagamento.
2.
Pagamento_id: Identifica o pagamento para fins de conciliação.
3.
Indice: Indica o índice atual do pagamento, útil em casos de múltiplos pagamentos.
4.
Token: Token do dispositivo no qual o pagamento será processado.
5.
Url_retorno: URL para redirecionamento após a conclusão do pagamento. Deve ser enviada como uma string vazia ("") caso não haja necessidade de redirecionamento.
6.
CNPJ: CNPJ da empresa que receberá o pagamento.

Parâmetros obrigatórios quando o modo fila está ativado:#

1.
Pedido: Número do pedido na loja.
2.
Identificador: CPF ou CNPJ do cliente.
3.
Nome: Nome completo do cliente.
4.
Nome_vendedor: Nome do vendedor responsável pela venda.

Parâmetros obrigatórios quando o tipo é 3 (PIX):#

1.
Identificador: CPF ou CNPJ do cliente.
2.
Nome: Nome completo do cliente.
Os demais campos podem ser utilizados conforme a necessidade, mas não são obrigatórios.

Suporte ao Cliente#

Lembramos que nossa equipe de suporte está sempre à disposição para auxiliá-lo em qualquer dúvida ou dificuldade que possa surgir durante o processo. Não hesite em entrar em contato!
Estamos empenhados em fornecer as melhores soluções e continuaremos a inovar para atender às suas necessidades.

Precisa de ajuda?#

Email: suporte@veloce.tech
Telefone: (51) 3108-0066
Base de Conhecimento: cac.veloce.tech
Feedback ou Sugestões: contato@veloce.tech

Requisição

Parâmetros Header
token
string 
requerido
Token gerado anteriormente em: https://smartef.apidog.io/api-10152772
Exemplo:
Dm3JkCcOYTk7WydQ5fjP4UP1ASFOfyc5Gs61lbLFcZ0PLYTdYJ
Parâmetros Bodyapplication/json
valor
number <double>
requerido
Valor do pagamento
pagamento_id
integer 
requerido
Id do pagamento para conciliação
indice
integer 
requerido
Indice atual do pagamento, caso necessário múltiplos pagamentos
token
string 
requerido
Token do dispositivo que deve ser efetuado o pagamento
url_retorno
string 
requerido
Url para retorno do pagamento após efeturar o mesmo (Envio será feito através de um POST com todos os atributos).
cnpj
string 
requerido
CNPJ da empresa que será enviado o pagamento
pedido
integer 
opcional
Número do pedido na loja
identificador
string 
opcional
CPF/CNPJ do Cliente
nome
string 
opcional
Nome do Cliente
nome_vendedor
string 
opcional
Nome do Vendedor que efetou a venda
parcelas
string 
opcional
Quantidade de parcelas
tipo
integer 
opcional
0 - Débito, 1 – Crédito, 2 – Crediário, 3 - Pix, 4 - Voucher
 descricao_secundario
string 
opcional
Lojista ou emissor (se vazio, o padrão definido é sempre lojista)
Exemplo
{
  "valor": 1,
  "pagamento_id": 2,
  "indice": 0,
  "token": "AY4MS",
  "Url_retorno": "",
  "cnpj": "07922150000100",
  "pedido": 987654321,
  "identificador_cliente": "12345678909",
  "nome_cliente": "João da Silva",
  "nome_vendedor": "Maria Oliveira",
  "parcelas": 3,
  "tipo": 1,
  "descricao_secundario": "lojista"
}

Exemplos de Requisição

Shell
JavaScript
Java
Swift
Go
PHP
Python
HTTP
C
C#
Objective-C
Ruby
OCaml
Dart
R
Request Request Example
Shell
JavaScript
Java
Swift
curl --location --request POST 'https://api.veloce.tech/api/v1/pagamento/criar' \
--header 'token: Dm3JkCcOYTk7WydQ5fjP4UP1ASFOfyc5Gs61lbLFcZ0PLYTdYJ' \
--header 'Content-Type: application/json' \
--data-raw '{
  "valor": 1,
  "pagamento_id": 2,
  "indice": 0,
  "token": "AY4MS",
  "Url_retorno": "",
  "cnpj": "07922150000100",
  "pedido": 987654321,
  "identificador_cliente": "12345678909",
  "nome_cliente": "João da Silva",
  "nome_vendedor": "Maria Oliveira",
  "parcelas": 3,
  "tipo": 1,
  "descricao_secundario": "lojista"
}'

Respostas

🟢200Success
application/json
Body
ok
boolean 
opcional
message
string 
opcional
result
object 
opcional
id_tbl_pagamento
integer 
opcional
Sequencial de pagamento gerado pelo sistema
fk_tbl_pagamento_id_empresa
integer 
opcional
Id de identificação da empresa
pagamento_id
integer 
opcional
Id do pagamento para conciliação de dados
indice
integer 
opcional
Indice atual do pagamento caso necessário múltiplos pagamentos
bandeira
string 
opcional
Bandeira do Cartão utilizado
order_id
string 
opcional
Ordem de pagamento retorno pela adquirente
auth_code
string 
opcional
AUT do pagamento
adquirente_code
string 
opcional
NSU/DOC do pagamento
parcelas
string 
opcional
Quantidade de parcelas
valor
number <double>
opcional
Valor do total do pagamento
dt_pagamento
string <date-time>
opcional
Data do pagamento
codigo_primario
string 
opcional
Código identificador do método primário de pagamento ex.: Débito, Crédito
codigo_secundario
string 
opcional
Código identificador do método secundário de pagamento ex.: À vista, Parcelado.
descricao_primario
string 
opcional
Descrição do identificador do método secundário de pagamento ex.: À vista, Parcelado.
descricao_secundario
string 
opcional
Descrição do identificador do método secundário de pagamento ex.: À vista, Parcelado.
status_code
integer 
opcional
Status da transação (CONFIRMED, PENDING e CANCELLED).
json_pagamento
string 
opcional
JSON de retorno do pagamento.
status
integer 
opcional
0 - Aberto, 1 - Em andamento, 2 - Efetuado pagamento, 3 - Erro ao efetuar pagamento
tipo
integer 
opcional
0 - Débito, 1 – Crédito, 2 – Voucher, 3 - Pix
status_mensagem
string 
opcional
Descrição do Status
status_cancelamento
integer 
opcional
0 - Aberto, 1 - Em andamento, 2 - Efetuado pagamento, 3 - Erro ao efetuar pagamento
status_cancelamento_mensagem
string 
opcional
Descrição do Status
motivo_cancelamento
string 
opcional
Motivo do cancelamento
dt_cancelamento
string <date-time>
opcional
Data de cancelamento do pagamento
json_cancelamento
string 
opcional
JSON de retorno do cancelamento.
numero_dispositivo
string 
opcional
Número do dispositivo
numero_ec
string 
opcional
Número EC do dispositivo
numero_logico
string 
opcional
Número Lógico do dispositivo
token
string 
opcional
Token dispositivo
url_retorno
string 
opcional
Url para retorno do pagamento após efeturar o mesmo (Envio será feito através de um POST com todos os atributos).
enviado
integer 
opcional
Informação se foi enviado ou não
dt_cadastro
string <date-time>
opcional
Data do cadastro
dt_alteracao
string <date-time>
opcional
Data de alteração
dt_exclusao
string <date-time>
opcional
Data de exclusão
identificador
string 
opcional
CPF/CNPJ do cliente
nome
string 
opcional
Nome do cliente
qr_code
string 
opcional
QRcode pix (se houver)
txid
string 
opcional
codigo de identificação da transação PIX
pix_id
string 
opcional
Identificado de pagamento PIX
guid_unique
string 
opcional
Identificado unico de cada pagamento
pedido
integer 
opcional
Numero do pedido cliente
vendedor
string 
opcional
Nome do vendedor
Examples
{
    "ok": true,
    "message": "Sucesso ao criar pagamento",
    "result": {
        "id_tbl_pagamento": 808375,
        "fk_tbl_pagamento_id_empresa": 11870,
        "pagamento_id": 1,
        "indice": 0,
        "bandeira": null,
        "order_id": null,
        "auth_code": null,
        "adquirente_code": null,
        "parcelas": "3",
        "valor": 10,
        "dt_pagamento": null,
        "codigo_primario": null,
        "codigo_secundario": null,
        "descricao_primario": null,
        "descricao_secundario": null,
        "status_code": null,
        "json_pagamento": null,
        "status": 0,
        "tipo": 1,
        "status_mensagem": null,
        "status_cancelamento": null,
        "status_cancelamento_mensagem": null,
        "motivo_cancelamento": null,
        "dt_cancelamento": null,
        "json_cancelamento": null,
        "numero_dispositivo": null,
        "numero_ec": null,
        "numero_logico": null,
        "token": "AY4MS",
        "url_retorno": null,
        "enviado": 2,
        "dt_cadastro": "2024-09-17 15:09:09",
        "dt_alteracao": "2024-09-17 15:10:19",
        "dt_exclusao": null,
        "identificador": null,
        "nome": null,
        "qr_code": null,
        "txid": null,
        "pix_id": null,
        "guid_unique": null,
        "pedido": 987654321,
        "vendedor": null
    }
}
🟠404Registro não encontrado
🟠400Informações faltantes
Página anterior
Gerar
Próxima página
Cancelar
Built with