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

Listar

GET
https://api.veloce.tech/api/v1/pagamento/listar
Última modificação:2024-09-25 17:11:59

Informações Complementares#

Para listar os pagamentos, é necessário fornecer pelo menos um dos parâmetros disponíveis. Informar todos os parâmetros é opcional.

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 Query
cnpj
string 
opcional
CNPJ da empresa que deseja acessar os pagamentos
Exemplo:
07922150000100
codigo_interno
string 
opcional
Código interno da empresa que deseja acessar os pagamentos
Exemplo:
Empresa01
dt_inicial
string <date-time>
opcional
Data incial dos pagamentos que deseja listar (01/09/2021 20:00:00)
Exemplo:
18/09/2024 15:30:00
dt_final
string <date-time>
opcional
Data final dos pagamentos que deseja listar (01/09/2021 20:00:00)
Exemplo:
18/09/2024 16:00:00
Parâmetros Header
token
string 
requerido
Token gerado anteriormente em: https://smartef.apidog.io/api-10152772
Exemplo:
kTskuSJRwjl4Ar1YqREO16syrRbimIZtvYTI5LFa9AWt3a1HcH

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 GET 'https://api.veloce.tech/api/v1/pagamento/listar?cnpj=07922150000100&codigo_interno=Empresa01&dt_inicial=18/09/2024 15:30:00&dt_final=18/09/2024 16:00:00' \
--header 'token: kTskuSJRwjl4Ar1YqREO16syrRbimIZtvYTI5LFa9AWt3a1HcH'

Respostas

🟢200Success
application/json
Body
ok
boolean 
opcional
message
string 
opcional
result
array [object {43}] 
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
string 
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
string 
opcional
pedido
integer 
opcional
vendedor
string 
opcional
empresa
object 
opcional
Exemplo
{
    "ok": true,
    "message": "A pesquisa retornou resultados",
    "result": [
        {
            "id_tbl_pagamento": 809472,
            "fk_tbl_pagamento_id_empresa": 11870,
            "pagamento_id": 4,
            "indice": 0,
            "bandeira": "MASTERCARD",
            "order_id": "c7da787e-b12c-4917-ae83-7261d68ddf26",
            "auth_code": "717177",
            "adquirente_code": "902054",
            "parcelas": "1",
            "valor": "1",
            "dt_pagamento": "2024-09-18 15:30:14",
            "codigo_primario": "1000",
            "codigo_secundario": "1",
            "descricao_primario": "CREDITO",
            "descricao_secundario": "A VISTA",
            "status_code": 2,
            "json_pagamento": "{jsonadquirente}",
            "status": 2,
            "tipo": 1,
            "status_mensagem": "Efetuado pagamento",
            "status_cancelamento": 2,
            "status_cancelamento_mensagem": "Efetuado pagamento",
            "motivo_cancelamento": "Teste de cancelamento",
            "dt_cancelamento": "2024-09-18 15:31:00",
            "json_cancelamento": "{jsonadquirente}",
            "numero_dispositivo": "ab329836cbc60bdd",
            "numero_ec": "0010911728439400",
            "numero_logico": "01435641-4",
            "token": "AY4MS",
            "url_retorno": null,
            "enviado": 2,
            "dt_cadastro": "2024-09-18 15:29:51",
            "dt_alteracao": "2024-09-18 15:31:01",
            "dt_exclusao": null,
            "identificador": null,
            "nome": null,
            "qr_code": null,
            "txid": null,
            "pix_id": null,
            "guid_unique": null,
            "pedido": 987654321,
            "vendedor": null,
            "empresa": {
                "id_tbl_empresa": 11870,
                "razao_social": "Empresa 01",
                "cnpj": "07922150000100",
                "logo": "6b1sODtotlWGcjOQETY5ntJSTUPwBNpmEfXEjV8H.png",
                "endereco": "Avenida Cristóvão Colombo",
                "endereco_numero": "2231",
                "endereco_complemento": "01",
                "cep": "15495000",
                "bairro": "Centro",
                "cidade": "Riolândia",
                "estado": "SP",
                "site": null,
                "email": "parque@veloce.com",
                "cod_pais": "",
                "ddd": "17",
                "telefone": "32911177",
                "dt_cadastro": "2022-04-01 09:33:07",
                "dt_alteracao": "2024-09-18 11:01:40",
                "dt_exclusao": null,
                "ie": "590015266114",
                "im": null,
                "nome_fantasia": "Empresa 01",
                "simples_nacional": 1,
                "tem_certificado": 0,
                "id_token_nfce": null,
                "token_nfce": null,
                "proxima_serie_nfce": 1,
                "id_imposto_simples_nacional": 0,
                "codigo_app_nfce": null,
                "fk_tbl_empresa_id_empresa": null,
                "matriz": 1,
                "ativo": 1,
                "cod_municipio": "3544202",
                "cod_estado": "35",
                "tipo": 1,
                "codigo_interno": "Empresa01",
                "venda_online": null,
                "incentivador_cultural": null,
                "incentivo_fiscal": null,
                "regime_tributario": null,
                "regime_tributario_especial": null,
                "api_referencia": null,
                "acessar_app": 0,
                "subdominio": "sahduashdua",
                "imagem_delivery": null,
                "numero_ec": null,
                "twitter": null,
                "instagram": null,
                "facebook": null,
                "motivo_exclusao": null,
                "subdominio_cardapio": "testeEnter",
                "bloqueado": "N",
                "motivo_bloqueio": null,
                "dt_bloqueio": null,
                "merchant_id": null,
                "client_id": null,
                "numero_ec_getnet": null
            }
        }
    ]
}
🟠404Registro não encontrado
🟠401Não autorizado
Página anterior
Cancelar
Próxima página
Rejeitar
Built with