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

Cancelar

POST
https://api.veloce.tech/api/v1/pagamento/cancelar
Última modificação:2024-09-25 17:11:48

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:
kTskuSJRwjl4Ar1YqREO16syrRbimIZtvYTI5LFa9AWt3a1HcH
Parâmetros Bodyapplication/json
indice
integer 
requerido
Indice atual do pagamento, caso necessário múltiplos pagamentos
pagamento_id
integer 
requerido
Id do pagamento para conciliação
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).
motivo_cancelamento
string 
requerido
Motivo do cancelamento
cnpj
string 
requerido
CNPJ da empresa que será enviado o pagamento
Exemplo
{
    "indice": 1,
    "pagamento_id": 5,
    "token": "XZ7PL",
    "url_retorno": "https://exemplo.com/retorno",
    "motivo_cancelamento": "Cancelamento automático",
    "cnpj": "12345678000199"
}

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/cancelar' \
--header 'token: kTskuSJRwjl4Ar1YqREO16syrRbimIZtvYTI5LFa9AWt3a1HcH' \
--header 'Content-Type: application/json' \
--data-raw '{
    "indice": 1,
    "pagamento_id": 5,
    "token": "XZ7PL",
    "url_retorno": "https://exemplo.com/retorno",
    "motivo_cancelamento": "Cancelamento automático",
    "cnpj": "12345678000199"
}'

Respostas

🟢200Success
application/json
Body
ok
boolean 
opcional
message
string 
opcional
result
object 
opcional
id_tbl_pagamento
integer 
opcional
fk_tbl_pagamento_id_empresa
integer 
opcional
pagamento_id
integer 
opcional
indice
integer 
opcional
bandeira
string 
opcional
order_id
null 
opcional
auth_code
string 
opcional
adquirente_code
string 
opcional
parcelas
string 
opcional
valor
number <double>
opcional
dt_pagamento
string <date-time>
opcional
codigo_primario
string 
opcional
codigo_secundario
string 
opcional
descricao_primario
string 
opcional
descricao_secundario
string 
opcional
status_code
integer 
opcional
json_pagamento
string 
opcional
status
integer 
opcional
tipo
integer 
opcional
status_mensagem
string 
opcional
status_cancelamento
integer 
opcional
status_cancelamento_mensagem
string 
opcional
motivo_cancelamento
string 
opcional
dt_cancelamento
string <date-time>
opcional
json_cancelamento
string 
opcional
numero_dispositivo
string 
opcional
numero_ec
string 
opcional
numero_logico
string 
opcional
token
string 
opcional
url_retorno
string 
opcional
enviado
integer 
opcional
dt_cadastro
string <date-time>
opcional
dt_alteracao
string <date-time>
opcional
dt_exclusao
string <date-time>
opcional
identificador
string 
opcional
nome
string 
opcional
qr_code
string 
opcional
txid
string 
opcional
pix_id
string 
opcional
guid_unique
null 
opcional
pedido
integer 
opcional
vendedor
null 
opcional
id_tbl_dispositivo
integer 
opcional
fk_tbl_dispositivo_id_empresa
integer 
opcional
descricao
string 
opcional
numero_caixa
string 
opcional
ativo
string 
opcional
alocacao
string 
opcional
vBCFCPST
string 
opcional
numero_producao
string 
opcional
serie_producao
string 
opcional
numero_homologacao
string 
opcional
serie_homologacao
string 
opcional
dt_consulta
string <date-time>
opcional
fk_tbl_dispositivo_id_usuario
integer 
opcional
product_flavors
string 
opcional
dt_venda
string <date-time>
opcional
fk_tbl_dispositivo_id_usuario_auto_servico
integer 
opcional
auto_servico
integer 
opcional
dt_up_ativo
string <date-time>
opcional
numero_dispositivo_hexa
string 
opcional
adquirente
string 
opcional
fk_tbl_dispositivo_id_adquirente
integer 
opcional
Exemplo
{
    "ok": true,
    "message": "Sucesso ao criar cancelamento de pagamento",
    "result": {
        "id_tbl_pagamento": 654321,
        "fk_tbl_pagamento_id_empresa": 54321,
        "pagamento_id": 4,
        "indice": 1,
        "bandeira": "ELO",
        "order_id": null,
        "auth_code": "123456",
        "adquirente_code": "2024091900009876",
        "parcelas": "3",
        "valor": "150.75",
        "dt_pagamento": "2024-09-19 16:30:10",
        "codigo_primario": "3000",
        "codigo_secundario": "2",
        "descricao_primario": "DÉBITO",
        "descricao_secundario": "PARCELADO",
        "status_code": 1,
        "json_pagamento": "Bundle[{jsonadquirente}]",
        "status": 1,
        "tipo": 2,
        "status_mensagem": "Pagamento realizado",
        "status_cancelamento": 1,
        "status_cancelamento_mensagem": null,
        "motivo_cancelamento": "Cancelamento por teste",
        "dt_cancelamento": null,
        "json_cancelamento": null,
        "numero_dispositivo": "abcd5678ef1234gh",
        "numero_ec": null,
        "numero_logico": null,
        "token": "JX5KL",
        "url_retorno": null,
        "enviado": 1,
        "dt_cadastro": "2023-01-15 12:20:45",
        "dt_alteracao": "2024-09-19 16:45:20",
        "dt_exclusao": null,
        "identificador": null,
        "nome": null,
        "qr_code": null,
        "txid": null,
        "pix_id": null,
        "guid_unique": null,
        "pedido": 123456789,
        "vendedor": null,
        "id_tbl_dispositivo": 87654,
        "fk_tbl_dispositivo_id_empresa": 54321,
        "descricao": "POS03",
        "numero_caixa": "002",
        "ativo": 1,
        "alocacao": null,
        "vBCFCPST": null,
        "numero_producao": null,
        "serie_producao": null,
        "numero_homologacao": null,
        "serie_homologacao": null,
        "dt_consulta": "2024-09-19 09:00:30",
        "fk_tbl_dispositivo_id_usuario": 9876,
        "product_flavors": "smartTefLite",
        "dt_venda": null,
        "fk_tbl_dispositivo_id_usuario_auto_servico": 9876,
        "auto_servico": 1,
        "dt_up_ativo": "2023-11-10 15:10:45",
        "numero_dispositivo_hexa": "5678ef1234ab90cd",
        "adquirente": "cielo",
        "fk_tbl_dispositivo_id_adquirente": 8
    }
}
🟠402Exceção
🟠404Registro não encontrado
Página anterior
Criar
Próxima página
Listar
Built with