Objetivo
A finalidade deste método é possibilitar a consulta de transações.
Chamada
GET/api/v1/Transacoes
Informações para Requisição (Request Information)
Parâmetros URI (URI Parameters)
| Nome (Name) | Descrição (Description) | Tipo (Type) | Informações Adicionais (Adittional Information) |
| Id | Id | Integer | Não há |
| IdAdquirente | IdAdquirente | Integer | Não há |
| IdArquivo | IdArquivo | Integer | Não há |
| IdLiquidacao | IdLiquidacao | Integer | Não há |
| IdEmpresa | IdEmpresa | Integer | Não há |
| Situacao | Situacao | String | Não há |
| Vinculado | Vinculado | String | Não há |
| ValorNominal | ValorNominal | Number | Não há |
| Status | Status | String | Não há |
| DataTransacaoInicial | DataTransacaoInicial | String | Não há |
| DataTransacaoFinal | DataTransacaoFinal | String | Não há |
| DataTransacao | DataTransacao | String | Não há |
| Expand | Expand | String | Não há |
| Fields | Fields | String | Não há |
| Order | Order | String | Não há |
| Page | Page | Integer | Não há |
| PageSize | PageSize | Integer | Não há |
Parâmetros do Corpo (Body Parameters)
Não há.
Informações para Resposta (Response Information)
Descrição do Recurso (Resource Description)
| Código (Code) | Descrição (Description) | Tipo (Type) | Informações Adicionais (Adittional Information) |
| 200 | Success | Não há | Não há |
Formatos de Resposta (Response Formats)
application/json, text/json
{
"hasNext": true,
"items": [
{
"id": 0,
"identificadorTransacao": "string",
"idCarrinho": "string",
"idEmpresa": 0,
"descReduzidoEmpresa": "string",
"dataTransacao": "2020-08-25T16:05:40.701Z",
"valorTaxaAdquirente": 0,
"valorBruto": 0,
"status": "string",
"transacaoVinculo": {
"id": 0,
"idTransacaoERP": 0,
"tipoVinculo": "string",
"dataHoraVinculo": "2020-08-25T16:05:40.701Z",
"idUsuario": 0,
"transacaoERP": {
"id": 0,
"idEmpresa": 0,
"idAdquirente": 0,
"idCarteira": "string",
"tipoCarteira": "string",
"nsu": "string",
"dataTransacao": "2020-08-25T16:05:40.701Z",
"valorTransacao": 0,
"valorTaxa": 0,
"idTitulo": 0,
"adquirente": {
"codigoAdquirente": "string",
"descricao": "string",
"adquirenteContas": [
{
"id": 0,
"nroEmpresa": 0,
"idLoja": "string",
"idConta": 0,
"empresa": {
"id": 0,
"idMatriz": 0,
"idEmpresaMae": 0,
"razaoSocial": "string",
"nomeReduzido": "string",
"cnpj": "string",
"status": "string",
"expandables": [
"string"
]
},
"conta": {
"id": 0,
"descricao": "string",
"idEmpresa": 0,
"idEmpresaMae": 0,
"status": "string",
"tipo": "string",
"numeroConta": "string",
"digitoConta": "string",
"idBanco": 0,
"idAgencia": 0,
"expandables": [
"string"
]
},
"expandables": [
"string"
]
}
],
"expandables": [
"string"
]
},
"empresa": {
"id": 0,
"idMatriz": 0,
"idEmpresaMae": 0,
"razaoSocial": "string",
"nomeReduzido": "string",
"cnpj": "string",
"status": "string",
"expandables": [
"string"
]
},
"expandables": [
"string"
]
},
"expandables": [
"string"
]
},
"idLiquidacao": 0,
"liquidacao": {
"id": 0,
"idArquivo": 0,
"arquivo": {
"id": 0,
"arquivoNome": "string",
"idAdquirente": 0,
"versao": "string",
"cnpj": 0,
"idUsuarioImportacao": 0,
"dataImportacao": "2020-08-25T16:05:40.701Z",
"dataHoraImportacao": "2020-08-25T16:05:40.701Z",
"dataMovimentacao": "2020-08-25T16:05:40.701Z",
"dataGeracao": "2020-08-25T16:05:40.701Z",
"dataHoraGeracao": "2020-08-25T16:05:40.701Z",
"tipoGeracao": "string",
"adquirente": {
"codigoAdquirente": "string",
"descricao": "string",
"adquirenteContas": [
{
"id": 0,
"nroEmpresa": 0,
"idLoja": "string",
"idConta": 0,
"empresa": {
"id": 0,
"idMatriz": 0,
"idEmpresaMae": 0,
"razaoSocial": "string",
"nomeReduzido": "string",
"cnpj": "string",
"status": "string",
"expandables": [
"string"
]
},
"conta": {
"id": 0,
"descricao": "string",
"idEmpresa": 0,
"idEmpresaMae": 0,
"status": "string",
"tipo": "string",
"numeroConta": "string",
"digitoConta": "string",
"idBanco": 0,
"idAgencia": 0,
"expandables": [
"string"
]
},
"expandables": [
"string"
]
}
],
"expandables": [
"string"
]
},
"usuario": {
"id": 0,
"codigo": "string",
"nome": "string",
"expandables": [
"string"
]
},
"liquidacoes": [
{
"id": 0,
"idArquivo": 0,
"arquivo": {
"id": 0,
"arquivoNome": "string",
"idAdquirente": 0,
"versao": "string",
"cnpj": 0,
"idUsuarioImportacao": 0,
"dataImportacao": "2020-08-25T16:05:40.702Z",
"dataHoraImportacao": "2020-08-25T16:05:40.702Z",
"dataMovimentacao": "2020-08-25T16:05:40.702Z",
"dataGeracao": "2020-08-25T16:05:40.702Z",
"dataHoraGeracao": "2020-08-25T16:05:40.702Z",
"tipoGeracao": "string",
"adquirente": {
"codigoAdquirente": "string",
"descricao": "string",
"adquirenteContas": [
{
"id": 0,
"nroEmpresa": 0,
"idLoja": "string",
"idConta": 0,
"empresa": {
"id": 0,
"idMatriz": 0,
"idEmpresaMae": 0,
"razaoSocial": "string",
"nomeReduzido": "string",
"cnpj": "string",
"status": "string",
"expandables": [
"string"
]
},
"conta": {
"id": 0,
"descricao": "string",
"idEmpresa": 0,
"idEmpresaMae": 0,
"status": "string",
"tipo": "string",
"numeroConta": "string",
"digitoConta": "string",
"idBanco": 0,
"idAgencia": 0,
"expandables": [
"string"
]
},
"expandables": [
"string"
]
}
],
"expandables": [
"string"
]
},
"usuario": {
"id": 0,
"codigo": "string",
"nome": "string",
"expandables": [
"string"
]
},
"liquidacoes": [
{
"id": 0,
"idArquivo": 0,
"identificadorLiquidacao": "string",
"dataLiquidacao": "2020-08-25T16:05:40.702Z",
"dataHoraLiquidacao": "2020-08-25T16:05:40.702Z",
"valorTaxaAdquirente": 0,
"valorLiquido": 0,
"valorBruto": 0,
"valorCancelado": 0,
"idBanco": 0,
"agencia": "string",
"contaCorrente": "string",
"digitoVerificador": "string",
"expandables": [
"string"
]
}
],
"quantidadeTransacaoVinculada": 0,
"expandables": [
"string"
]
},
"identificadorLiquidacao": "string",
"dataLiquidacao": "2020-08-25T16:05:40.702Z",
"dataHoraLiquidacao": "2020-08-25T16:05:40.702Z",
"valorTaxaAdquirente": 0,
"valorLiquido": 0,
"valorBruto": 0,
"valorCancelado": 0,
"idBanco": 0,
"agencia": "string",
"contaCorrente": "string",
"digitoVerificador": "string",
"expandables": [
"string"
]
}
],
"quantidadeTransacaoVinculada": 0,
"expandables": [
"string"
]
},
"identificadorLiquidacao": "string",
"dataLiquidacao": "2020-08-25T16:05:40.702Z",
"dataHoraLiquidacao": "2020-08-25T16:05:40.702Z",
"valorTaxaAdquirente": 0,
"valorLiquido": 0,
"valorBruto": 0,
"valorCancelado": 0,
"idBanco": 0,
"agencia": "string",
"contaCorrente": "string",
"digitoVerificador": "string",
"expandables": [
"string"
]
},
"idLiquidacaoCancelamento": 0,
"liquidacaoCancelamento": {
"id": 0,
"idArquivo": 0,
"arquivo": {
"id": 0,
"arquivoNome": "string",
"idAdquirente": 0,
"versao": "string",
"cnpj": 0,
"idUsuarioImportacao": 0,
"dataImportacao": "2020-08-25T16:05:40.702Z",
"dataHoraImportacao": "2020-08-25T16:05:40.702Z",
"dataMovimentacao": "2020-08-25T16:05:40.702Z",
"dataGeracao": "2020-08-25T16:05:40.702Z",
"dataHoraGeracao": "2020-08-25T16:05:40.702Z",
"tipoGeracao": "string",
"adquirente": {
"codigoAdquirente": "string",
"descricao": "string",
"adquirenteContas": [
{
"id": 0,
"nroEmpresa": 0,
"idLoja": "string",
"idConta": 0,
"empresa": {
"id": 0,
"idMatriz": 0,
"idEmpresaMae": 0,
"razaoSocial": "string",
"nomeReduzido": "string",
"cnpj": "string",
"status": "string",
"expandables": [
"string"
]
},
"conta": {
"id": 0,
"descricao": "string",
"idEmpresa": 0,
"idEmpresaMae": 0,
"status": "string",
"tipo": "string",
"numeroConta": "string",
"digitoConta": "string",
"idBanco": 0,
"idAgencia": 0,
"expandables": [
"string"
]
},
"expandables": [
"string"
]
}
],
"expandables": [
"string"
]
},
"usuario": {
"id": 0,
"codigo": "string",
"nome": "string",
"expandables": [
"string"
]
},
"liquidacoes": [
{
"id": 0,
"idArquivo": 0,
"arquivo": {
"id": 0,
"arquivoNome": "string",
"idAdquirente": 0,
"versao": "string",
"cnpj": 0,
"idUsuarioImportacao": 0,
"dataImportacao": "2020-08-25T16:05:40.703Z",
"dataHoraImportacao": "2020-08-25T16:05:40.703Z",
"dataMovimentacao": "2020-08-25T16:05:40.703Z",
"dataGeracao": "2020-08-25T16:05:40.703Z",
"dataHoraGeracao": "2020-08-25T16:05:40.703Z",
"tipoGeracao": "string",
"adquirente": {
"codigoAdquirente": "string",
"descricao": "string",
"adquirenteContas": [
{
"id": 0,
"nroEmpresa": 0,
"idLoja": "string",
"idConta": 0,
"empresa": {
"id": 0,
"idMatriz": 0,
"idEmpresaMae": 0,
"razaoSocial": "string",
"nomeReduzido": "string",
"cnpj": "string",
"status": "string",
"expandables": [
"string"
]
},
"conta": {
"id": 0,
"descricao": "string",
"idEmpresa": 0,
"idEmpresaMae": 0,
"status": "string",
"tipo": "string",
"numeroConta": "string",
"digitoConta": "string",
"idBanco": 0,
"idAgencia": 0,
"expandables": [
"string"
]
},
"expandables": [
"string"
]
}
],
"expandables": [
"string"
]
},
"usuario": {
"id": 0,
"codigo": "string",
"nome": "string",
"expandables": [
"string"
]
},
"liquidacoes": [
{
"id": 0,
"idArquivo": 0,
"identificadorLiquidacao": "string",
"dataLiquidacao": "2020-08-25T16:05:40.703Z",
"dataHoraLiquidacao": "2020-08-25T16:05:40.703Z",
"valorTaxaAdquirente": 0,
"valorLiquido": 0,
"valorBruto": 0,
"valorCancelado": 0,
"idBanco": 0,
"agencia": "string",
"contaCorrente": "string",
"digitoVerificador": "string",
"expandables": [
"string"
]
}
],
"quantidadeTransacaoVinculada": 0,
"expandables": [
"string"
]
},
"identificadorLiquidacao": "string",
"dataLiquidacao": "2020-08-25T16:05:40.703Z",
"dataHoraLiquidacao": "2020-08-25T16:05:40.703Z",
"valorTaxaAdquirente": 0,
"valorLiquido": 0,
"valorBruto": 0,
"valorCancelado": 0,
"idBanco": 0,
"agencia": "string",
"contaCorrente": "string",
"digitoVerificador": "string",
"expandables": [
"string"
]
}
],
"quantidadeTransacaoVinculada": 0,
"expandables": [
"string"
]
},
"identificadorLiquidacao": "string",
"dataLiquidacao": "2020-08-25T16:05:40.703Z",
"dataHoraLiquidacao": "2020-08-25T16:05:40.703Z",
"valorTaxaAdquirente": 0,
"valorLiquido": 0,
"valorBruto": 0,
"valorCancelado": 0,
"idBanco": 0,
"agencia": "string",
"contaCorrente": "string",
"digitoVerificador": "string",
"expandables": [
"string"
]
},
"idCaixa": "string",
"dataHoraTransacao": "2020-08-25T16:05:40.703Z",
"dataCancelamento": "2020-08-25T16:05:40.703Z",
"dataHoraCancelamento": "2020-08-25T16:05:40.703Z",
"dataLiquidacao": "2020-08-25T16:05:40.703Z",
"valorLiquido": 0,
"dataHoraImportacao": "2020-08-25T16:05:40.703Z",
"nomeArquivo": "string",
"vinculado": "string",
"expandables": [
"string"
]
}
]
}| Código (Code) | Descrição (Description) | Tipo (Type) | Informações Adicionais (Adittional Information) |
| 400 | Bad Request | Não há | Não há |
application/json, text/json
{
"code": "string",
"message": "string",
"detailedMessage": "string",
"helpUrl": "string",
"details": [
{
"guid": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"notificationType": 0,
"code": "string",
"message": "string",
"detailedMessage": "string",
"status": 0
}
]
}
Visão Geral
Import HTML Content
Conteúdo das Ferramentas
Tarefas